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):
528 # "BSL entry sequence at dedicated JTAG pins"
529 # rst !s0: 0 0 0 0 1 1
530 # tck !s1: 1 0 1 0 0 1
533 # "BSL entry sequence at shared JTAG pins"
534 # rst !s0: 0 0 0 0 1 1
535 # tck !s1: 0 1 0 1 1 0
539 self.telosI2CWriteCmd(0,1)
540 self.telosI2CWriteCmd(0,3)
541 self.telosI2CWriteCmd(0,1)
542 self.telosI2CWriteCmd(0,3)
543 self.telosI2CWriteCmd(0,2)
544 self.telosI2CWriteCmd(0,0)
546 self.telosI2CWriteCmd(0,3)
547 self.telosI2CWriteCmd(0,2)
549 # This line was not defined inside the else: block, not sure where it
551 self.telosI2CWriteCmd(0,0)
552 time.sleep(0.250) #give MSP430's oscillator time to stabilize
553 self.serialport.flushInput() #clear buffers
555 def bslReset(self, invokeBSL=0):
556 """Applies BSL entry sequence on RST/NMI and TEST/VPP pins
558 invokeBSL = 1: complete sequence
559 invokeBSL = 0: only RST/NMI pin accessed
561 RST is inverted twice on boot loader hardware
562 TEST is inverted (only once)
563 Need positive voltage on DTR, RTS for power-supply of hardware"""
565 self.telosBReset(invokeBSL)
568 if DEBUG > 1: sys.stderr.write("* bslReset(invokeBSL=%s)\n" % invokeBSL)
569 self.SetRSTpin(1) #power suply
570 self.SetTESTpin(1) #power suply
571 time.sleep(0.250) #charge capacitor on boot loader hardware
578 self.SetRSTpin(0) #RST pin: GND
580 self.SetTESTpin(1) #TEST pin: GND
581 self.SetTESTpin(0) #TEST pin: Vcc
582 self.SetTESTpin(1) #TEST pin: GND
583 self.SetTESTpin(0) #TEST pin: Vcc
584 self.SetRSTpin (1) #RST pin: Vcc
585 self.SetTESTpin(1) #TEST pin: GND
587 self.SetRSTpin(1) #RST pin: Vcc
588 time.sleep(0.250) #give MSP430's oscillator time to stabilize
590 self.serialport.flushInput() #clear buffers
592 def bslSync(self,wait=0):
593 """Transmits Synchronization character and expects to receive Acknowledge character
594 if wait is 0 it must work the first time. otherwise if wait is 1
595 it is retried (forever).
597 loopcnt = 5 #Max. tries to get synchronization
599 if DEBUG > 1: sys.stderr.write("* bslSync(wait=%d)\n" % wait)
600 while wait or loopcnt:
601 loopcnt = loopcnt - 1 #count down tries
602 self.serialport.flushInput() #clear input, in case a prog is running
604 self.serialport.write(chr(self.BSL_SYNC)) #Send synchronization byte
605 c = self.serialport.read(1) #read answer
606 if c == chr(self.DATA_ACK): #ACk
607 if DEBUG > 1: sys.stderr.write(" bslSync() OK\n")
608 return #Sync. successful
612 sys.stderr.write(" bslSync() timeout, retry ...\n")
614 #nmi may have caused the first reset to be ignored, try again
619 sys.stderr.write(" bslSync() timeout, retry ...\n")
622 sys.stderr.write(" bslSync() timeout\n")
624 if DEBUG > 1: sys.stderr.write(" bslSync() failed (0x%02x), retry ...\n" % ord(c))
626 raise BSLException(self.ERR_BSL_SYNC) #Sync. failed
628 def bslTxRx(self, cmd, addr, length = 0, blkout = None, wait=0):
629 """Transmits a command (cmd) with its parameters:
630 start-address (addr), length (len) and additional
631 data (blkout) to boot loader.
632 wait specified if the bsl sync should be tried once or
634 Parameters return by boot loader are passed via blkin.
636 if DEBUG > 1: sys.stderr.write("* bslTxRx()\n")
638 if cmd == self.BSL_TXBLK:
639 #Align to even start address
641 addr = addr - 1 #Decrement address and
642 blkout = chr(0xFF) + blkOut #fill first byte of blkout with 0xFF
644 #Make sure that len is even
645 if (length % 2) != 0:
646 blkout = blkout + chr(0xFF) #Inc. len and fill last byte of blkout with 0xFF
649 elif cmd == self.BSL_RXBLK:
650 #Align to even start address
652 addr = addr - 1 #Decrement address but
653 length = length + 1 #request an additional byte
654 #Make sure that len is even
655 if (length % 2) != 0:
658 #if cmd == self.BSL_TXBLK or cmd == self.BSL_TXPWORD:
661 #Add necessary information data to frame
662 dataOut = struct.pack("<HH", addr, length)
664 if blkout: #Copy data out of blkout into frame
665 dataOut = dataOut + blkout
667 self.bslSync(wait) #synchronize BSL
668 rxFrame = self.comTxRx(cmd, dataOut, len(dataOut)) #Send frame
669 if rxFrame: #test answer
670 return rxFrame[4:] #return only data w/o [hdr,null,len,len]
676 """store a string with memory contents along with its startaddress"""
677 def __init__(self, startaddress = 0, data=None):
682 self.startaddress = startaddress
684 def __getitem__(self, index):
685 return self.data[index]
688 return len(self.data)
691 return "Segment(startaddress = 0x%04x, data=%r)" % (self.startaddress, self.data)
694 """represent memory contents. with functions to load files"""
695 def __init__(self, filename=None):
698 self.filename = filename
699 self.loadFile(filename)
701 def append(self, seg):
702 self.segments.append(seg)
704 def __getitem__(self, index):
705 return self.segments[index]
708 return len(self.segments)
710 def loadIHex(self, file):
711 """load data from a (opened) file in Intel-HEX format"""
715 lines = file.readlines()
717 if l[0] != ':': raise BSLException("File Format Error\n")
718 l = l.strip() #fix CR-LF issues...
719 length = int(l[1:3],16)
720 address = int(l[3:7],16)
721 type = int(l[7:9],16)
722 check = int(l[-2:],16)
724 if currentAddr != address:
726 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
727 startAddr = currentAddr = address
729 for i in range(length):
730 segmentdata.append( chr(int(l[9+2*i:11+2*i],16)) )
731 currentAddr = length + currentAddr
732 elif type in (0x01, 0x02, 0x03, 0x04, 0x05):
735 sys.stderr.write("Ignored unknown field (type 0x%02x) in ihex file.\n" % type)
737 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
739 def loadTIText(self, file):
740 """load data from a (opened) file in TI-Text format"""
744 #Convert data for MSP430, TXT-File is parsed line by line
750 if l[0] == 'q': break
751 elif l[0] == '@': #if @ => new address => send frame and set new addr.
752 #create a new segment
754 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
755 startAddr = int(l[1:],16)
758 for i in string.split(l):
759 segmentdata.append(chr(int(i,16)))
761 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
763 def loadELF(self, file):
764 """load data from a (opened) file in ELF object format.
765 File must be seekable"""
767 obj = elf.ELFObject()
769 if obj.e_type != elf.ELFObject.ET_EXEC:
770 raise Exception("No executable")
771 for section in obj.getSections():
773 sys.stderr.write("ELF section %s at 0x%04x %d bytes\n" % (section.name, section.lma, len(section.data)))
774 if len(section.data):
775 self.segments.append( Segment(section.lma, section.data) )
777 def loadFile(self, filename):
778 """fill memory with the contents of a file. file type is determined from extension"""
779 #TODO: do a contents based detection
780 if filename[-4:].lower() == '.txt':
781 self.loadTIText(open(filename, "rb"))
782 elif filename[-4:].lower() in ('.a43', '.hex'):
783 self.loadIHex(open(filename, "rb"))
785 self.loadELF(open(filename, "rb"))
787 def getMemrange(self, fromadr, toadr):
788 """get a range of bytes from the memory. unavailable values are filled with 0xff."""
790 toadr = toadr + 1 #python indxes are excluding end, so include it
791 while fromadr < toadr:
792 #print "fromto: %04x %04x" % (fromadr, toadr)
793 for seg in self.segments:
795 segend = seg.startaddress + len(seg.data)
796 if seg.startaddress <= fromadr and fromadr < segend:
797 #print "startok 0x%04x %d" % (seg.startaddress, len(seg.data))
798 #print ("0x%04x "*3) % (segend, fromadr, toadr)
799 if toadr > segend: #not all data in segment
800 #print "out of segment"
801 catchlength = segend-fromadr
803 catchlength = toadr-fromadr
806 res = res + seg.data[fromadr-seg.startaddress : fromadr-seg.startaddress+catchlength]
807 fromadr = fromadr + catchlength #adjust start
808 if len(res) >= toadr-fromadr:
812 fromadr = fromadr + 1 #adjust start
814 #print "res: %r" % res
818 class BootStrapLoader(LowLevel):
819 """higher level Bootstrap Loader functions."""
821 ERR_VERIFY_FAILED = "Error: verification failed"
822 ERR_ERASE_CHECK_FAILED = "Error: erase check failed"
824 ACTION_PROGRAM = 0x01 #Mask: program data
825 ACTION_VERIFY = 0x02 #Mask: verify data
826 ACTION_ERASE_CHECK = 0x04 #Mask: erase check
828 #Max. bytes sent within one frame if parsing a TI TXT file.
829 #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
833 def __init__(self, *args, **kargs):
834 LowLevel.__init__(self, *args, **kargs)
836 self.meraseCycles = 1
837 self.patchRequired = 0
842 self.maxData = self.MAXDATA
846 def preparePatch(self):
847 """prepare to download patch"""
848 if DEBUG > 1: sys.stderr.write("* preparePatch()\n")
851 #Load PC with 0x0220.
852 #This will invoke the patched bootstrap loader subroutines.
853 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
854 0x0220) #Address to load into PC
855 self.BSLMemAccessWarning = 0 #Error is removed within workaround code
859 """setup after the patch is loaded"""
860 if DEBUG > 1: sys.stderr.write("* postPatch()\n")
862 self.BSLMemAccessWarning = 1 #Turn warning back on.
865 def verifyBlk(self, addr, blkout, action):
866 """verify memory against data or 0xff"""
867 if DEBUG > 1: sys.stderr.write("* verifyBlk()\n")
869 if action & self.ACTION_VERIFY or action & self.ACTION_ERASE_CHECK:
870 if DEBUG: sys.stderr.write(" Check starting at 0x%04x, %d bytes ... \n" % (addr, len(blkout)))
873 blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
876 for i in range(len(blkout)):
877 if action & self.ACTION_VERIFY:
878 #Compare data in blkout and blkin
879 if blkin[i] != blkout[i]:
880 sys.stderr.write("Verification failed at 0x%04x (0x%02x, 0x%02x)\n" % (addr+i, ord(blkin[i]), ord(blkout[i])))
882 raise BSLException(self.ERR_VERIFY_FAILED) #Verify failed!
884 elif action & self.ACTION_ERASE_CHECK:
885 #Compare data in blkin with erase pattern
886 if blkin[i] != chr(0xff):
887 sys.stderr.write("Erase Check failed at 0x%04x (0x%02x)\n" % (addr+i, ord(blkin[i])))
889 raise BSLException(self.ERR_ERASE_CHECK_FAILED) #Erase Check failed!
891 def readBlk(self,adr,len):
892 """Read a block of memory."""
893 blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
895 def programBlk(self, addr, blkout, action):
896 """program a memory block"""
897 if DEBUG > 1: sys.stderr.write("* programBlk()\n")
899 #Check, if specified range is erased
900 self.verifyBlk(addr, blkout, action & self.ACTION_ERASE_CHECK)
902 if action & self.ACTION_PROGRAM:
903 if DEBUG: sys.stderr.write(" Program starting at 0x%04x, %i bytes ...\n" % (addr, len(blkout)))
906 self.bslTxRx(self.BSL_TXBLK, addr, len(blkout), blkout)
910 self.verifyBlk(addr, blkout, action & self.ACTION_VERIFY)
913 #list of tuples or lists:
914 #segements = [ (addr1, [d0,d1,d2,...]), (addr2, [e0,e1,e2,...])]
915 def programData(self, segments, action):
916 """programm or verify data"""
917 if DEBUG > 1: sys.stderr.write("* programData()\n")
919 currentAddr = seg.startaddress
921 while pstart<len(seg.data):
922 length = self.MAXDATA
923 if pstart+length > len(seg.data):
924 length = len(seg.data) - pstart
925 self.programBlk(currentAddr, seg.data[pstart:pstart+length], action)
926 pstart = pstart + length
927 currentAddr = currentAddr + length
928 self.byteCtr = self.byteCtr + length #total sum
930 def uploadData(self, startaddress, size, wait=0):
931 """upload a datablock"""
932 if DEBUG > 1: sys.stderr.write("* uploadData()\n")
936 length = self.maxData
937 if pstart+length > size:
938 length = size - pstart
939 data = data + self.bslTxRx(self.BSL_RXBLK,
942 wait=wait)[:-2] #cut away checksum
943 pstart = pstart + length
946 def txPasswd(self, passwd=None, wait=0):
947 """transmit password, default if None is given."""
948 if DEBUG > 1: sys.stderr.write("* txPassword(%r)\n" % passwd)
950 #Send "standard" password to get access to protected functions.
951 sys.stderr.write("Transmit default password ...\n")
953 #Flash is completely erased, the contents of all Flash cells is 0xff
954 passwd = chr(0xff)*32
956 #sanity check of password
957 if len(passwd) != 32:
958 raise ValueError, "password has wrong length (%d)\n" % len(passwd)
959 sys.stderr.write('Transmit password ...\n')
962 self.bslTxRx(self.BSL_TXPWORD, #Command: Transmit Password
963 0xffe0, #Address of interupt vectors
964 0x0020, #Number of bytes
966 wait=wait) #if wait is 1, try to sync forever
969 #-----------------------------------------------------------------
971 def actionMassErase(self):
972 """Erase the flash memory completely (with mass erase command)"""
973 sys.stderr.write("Mass Erase...\n")
975 self.bslReset(1) #Invoke the boot loader.
976 for i in range(self.meraseCycles):
977 if i == 1: sys.stderr.write("Additional Mass Erase Cycles...\n")
978 self.bslTxRx(self.BSL_MERAS, #Command: Mass Erase
979 0xff00, #Any address within flash memory.
980 0xa506) #Required setting for mass erase!
981 self.passwd = None #No password file required!
982 #print "Mass Erase complete"
983 #Transmit password to get access to protected BSL functions.
986 def actionStartBSL(self, usepatch=1, adjsp=1, replacementBSL=None, forceBSL=0, mayuseBSL=0, speed=None, bslreset=1):
987 """start BSL, download patch if desired and needed, adjust SP if desired"""
988 sys.stderr.write("Invoking BSL...\n")
991 #for '30, invertTEST=0, else =1
993 self.bslReset(1) #Invoke the boot loader.
996 self.txPasswd(self.passwd) #transmit password
998 #Read actual bootstrap loader version.
999 #sys.stderr.write("Reading BSL version ...\n")
1000 blkin = self.bslTxRx(self.BSL_RXBLK, #Command: Read/Receive Block
1001 0x0ff0, #Start address
1002 16) #No. of bytes to read
1003 dev_id, bslVerHi, bslVerLo = struct.unpack(">H8xBB4x", blkin[:-2]) #cut away checksum and extract data
1007 if self.cpu is None: #cpy type forced?
1008 if deviceids.has_key(dev_id):
1009 self.cpu = deviceids[dev_id] #try to autodectect CPU type
1012 sys.stderr.write("Autodetect successful: %04x -> %s\n" % (dev_id, self.cpu))
1014 sys.stderr.write("Autodetect failed! Unkown ID: %04x. Trying to continue anyway.\n" % dev_id)
1015 self.cpu = F1x #assume something and try anyway..
1017 sys.stderr.write("Current bootstrap loader version: %x.%x (Device ID: %04x)\n" % (bslVerHi, bslVerLo, dev_id))
1019 self.bslVer = (bslVerHi << 8) | bslVerLo
1021 if self.bslVer <= 0x0110: #check if patch is needed
1022 self.BSLMemAccessWarning = 1
1024 self.BSLMemAccessWarning = 0 #Fixed in newer versions of BSL.
1026 if self.bslVer <= 0x0130 and adjsp:
1027 #only do this on BSL where it's needed to prevent
1028 #malfunction with F4xx devices/ newer ROM-BSLs
1030 #Execute function within bootstrap loader
1031 #to prepare stack pointer for the following patch.
1032 #This function will lock the protected functions again.
1033 sys.stderr.write("Adjust SP. Load PC with 0x0C22 ...\n")
1034 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1035 0x0C22) #Address to load into PC
1036 #Re-send password to re-gain access to protected functions.
1037 self.txPasswd(self.passwd)
1039 #get internal BSL replacement if needed or forced by the user
1040 #required if speed is set but an old BSL is in the device
1041 #if a BSL is given by the user, that one is used and not the internal one
1042 if ((mayuseBSL and speed and self.bslVer < 0x0150) or forceBSL) and replacementBSL is None:
1043 replacementBSL = Memory() #File to program
1046 sys.stderr.write("Using built in BSL replacement for F4x devices\n")
1048 replacementBSL.loadTIText(cStringIO.StringIO(F4X_BSL)) #parse embedded BSL
1051 sys.stderr.write("Using built in BSL replacement for F1x devices\n")
1053 replacementBSL.loadTIText(cStringIO.StringIO(F1X_BSL)) #parse embedded BSL
1055 #now download the new BSL, if allowed and needed (version lower than the
1056 #the replacement) or forced
1057 if replacementBSL is not None:
1058 self.actionDownloadBSL(replacementBSL)
1060 #debug message with the real BSL version in use (may have changed after replacement BSL)
1062 sys.stderr.write("Current bootstrap loader version: 0x%04x\n" % (self.bslVer,))
1065 #now apply workarounds or patches if BSL in use requires that
1066 if self.bslVer <= 0x0110: #check if patch is needed
1067 if usepatch: #test if patch is desired
1068 sys.stderr.write("Patch for flash programming required!\n")
1069 self.patchRequired = 1
1071 sys.stderr.write("Load and verify patch ...\n")
1073 #Programming and verification is done in one pass.
1074 #The patch file is only read and parsed once.
1075 segments = Memory() #data to program
1076 segments.loadTIText(cStringIO.StringIO(PATCH)) #parse embedded patch
1078 self.programData(segments, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1079 self.patchLoaded = 1
1082 sys.stderr.write("Device needs patch, but not applied (usepatch is false).\n") #message if not patched
1084 #should the baudrate be changed?
1085 if speed is not None:
1086 self.actionChangeBaudrate(speed) #change baudrate
1088 def actionDownloadBSL(self, bslsegments):
1089 sys.stderr.write("Load new BSL into RAM...\n")
1091 self.programData(bslsegments, self.ACTION_PROGRAM)
1092 sys.stderr.write("Verify new BSL...\n")
1094 self.programData(bslsegments, self.ACTION_VERIFY) #File to verify
1096 #Read startvector of bootstrap loader
1097 #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0300, 2)
1098 #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0220, 2)
1099 blkin = self.bslTxRx(self.BSL_RXBLK, bslsegments[0].startaddress, 2)
1100 startaddr = struct.unpack("<H", blkin[:2])[0]
1102 sys.stderr.write("Starting new BSL at 0x%04x...\n" % startaddr)
1104 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1105 startaddr) #Address to load into PC
1107 #BSL-Bugs should be fixed within "new" BSL
1108 self.BSLMemAccessWarning = 0
1109 self.patchRequired = 0
1110 self.patchLoaded = 0
1112 #Re-send password to re-gain access to protected functions.
1113 self.txPasswd(self.passwd)
1115 #update version info
1116 #verison only valid for the internal ones, but it also makes sure
1117 #that the patches are not applied if the user d/ls one
1118 self.bslVer = 0x0150
1120 def actionEraseCheck(self):
1121 """check the erasure of required flash cells."""
1122 sys.stderr.write("Erase Check by file ...\n")
1124 if self.data is not None:
1125 self.programData(self.data, self.ACTION_ERASE_CHECK)
1127 raise BSLException, "cannot do erase check against data with not knowing the actual data"
1129 def actionProgram(self):
1130 """program data into flash memory."""
1131 if self.data is not None:
1132 sys.stderr.write("Program ...\n")
1134 self.programData(self.data, self.ACTION_PROGRAM)
1135 sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1138 raise BSLException, "programming without data not possible"
1139 def actionFromweb(self):
1140 """Grab GoodFET firmware from the web, then flash it."""
1141 print "Grabbing %x firmware." % self.dev_id;
1142 print "%s" % firmware[self.dev_id];
1143 fn="/tmp/.goodfet.hex"
1144 os.system("curl %s >%s" % (firmware[self.dev_id],fn))
1147 #fw.loadIhex(open(fn,"rb"));
1149 sys.stderr.write("Program ...\n")
1151 self.programData(fw, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1152 sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1155 def actionVerify(self):
1156 """Verify programmed data"""
1157 if self.data is not None:
1158 sys.stderr.write("Verify ...\n")
1160 self.programData(self.data, self.ACTION_VERIFY)
1162 raise BSLException, "verify without data not possible"
1164 def actionReset(self):
1165 """perform a reset, start user programm"""
1166 sys.stderr.write("Reset device ...\n")
1168 self.bslReset(0) #only reset
1170 def actionRun(self, address=0x220):
1171 """start program at specified address"""
1172 sys.stderr.write("Load PC with 0x%04x ...\n" % address)
1174 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1175 address) #Address to load into PC
1177 #table with values from slaa089a.pdf
1180 9600:[0x8580, 0x0000],
1181 19200:[0x86e0, 0x0001],
1182 38400:[0x87e0, 0x0002],
1185 9600:[0x8580, 0x0000],
1186 19200:[0x8B00, 0x0001],
1187 38400:[0x8C80, 0x0002],
1190 9600:[0x9800, 0x0000],
1191 19200:[0xb000, 0x0001],
1192 38400:[0xc800, 0x0002],
1195 def actionChangeBaudrate(self, baudrate=9600):
1196 """change baudrate. first the command is sent, then the comm
1197 port is reprogrammed. only possible with newer MSP430-BSL versions.
1198 (ROM >=1.6, downloadable >=1.5)"""
1200 baudconfigs = self.bauratetable[self.cpu]
1202 raise ValueError, "unknown CPU type %s, can't switch baudrate" % self.cpu
1204 a,l = baudconfigs[baudrate]
1206 raise ValueError, "baudrate not valid. valid values are %r" % baudconfigs.keys()
1208 sys.stderr.write("Changing baudrate to %d ...\n" % baudrate)
1210 self.bslTxRx(self.BSL_CHANGEBAUD, #Command: change baudrate
1211 a, l) #args are coded in adr and len
1212 time.sleep(0.010) #recomended delay
1213 self.serialport.setBaudrate(baudrate)
1215 def actionReadBSLVersion(self):
1216 """informational output of BSL version number.
1217 (newer MSP430-BSLs only)"""
1218 ans = self.bslTxRx(self.BSL_TXVERSION, 0) #Command: receive version info
1219 #the following values are in big endian style!!!
1220 family_type, bsl_version = struct.unpack(">H8xH4x", ans[:-2]) #cut away checksum and extract data
1221 print "Device Type: 0x%04x\nBSL version: 0x%04x\n" % (family_type, bsl_version)
1225 """print some help message"""
1226 sys.stderr.write("""
1227 USAGE: %s [options] [file]
1230 If "-" is specified as file the data is read from the stdinput.
1231 A file ending with ".txt" is considered to be in TIText format,
1232 '.a43' and '.hex' as IntelHex and all other filenames are
1233 considered as ELF files.
1236 -h, --help Show this help screen.
1237 -c, --comport=port Specify the communication port to be used.
1242 -P, --password=file Specify a file with the interrupt vectors that
1243 are used as password. This can be any file that
1244 has previously been used to program the device.
1245 (e.g. -P INT_VECT.TXT).
1246 -f, --framesize=num Max. number of data bytes within one transmitted
1247 frame (16 to 240 in steps of 16) (e.g. -f 240).
1248 -m, --erasecycles=num Number of mass erase cycles (default is 1). Some
1249 old F149 devices need additional erase cycles.
1250 On newer devices it is no longer needed. (e.g. for
1252 -U, --unpatched Do not download the BSL patch, even when it is
1253 needed. This is used when a program is downloaded
1254 into RAM and executed from there (and where flash
1255 programming is not needed.)
1256 -D, --debug Increase level of debug messages. This won't be
1257 very useful for the average user...
1258 -I, --intelhex Force fileformat to IntelHex
1259 -T, --titext Force fileformat to be TIText
1260 -N, --notimeout Don't use timeout on serial port (use with care)
1261 -B, --bsl=bsl.txt Load and use new BSL from the TI Text file
1262 -S, --speed=baud Reconfigure speed, only possible with newer
1263 MSP403-BSL versions (>1.5, read slaa089a.pdf for
1264 details). If the --bsl option is not used, an
1265 internal BSL replacement will be loaded.
1266 Needs a target with at least 2kB RAM!
1267 Possible values are 9600, 19200, 38400
1269 -1, --f1x Specify CPU family, in case autodetect fails
1270 -2, --f2x Specify CPU family, in case autodetect fails
1271 -4, --f4x Specify CPU family, in case autodetect fails
1272 --F1x and --f2x are only needed when the "change
1273 baudrate" feature is used and the autodetect feature
1274 fails. If the device ID that is uploaded is known, it
1275 has precedence to the command line option.
1276 --invert-reset Invert signal on RST pin (used for some BSL hardware)
1277 --invert-test Invert signal on TEST/TCK pin (used for some BSL
1279 --swap-reset-test Swap the RST and TEST pins (used for some BSL hardware)
1280 --telos-latch Special twiddle in BSL reset for Telos hardware
1281 --telos-i2c DTR/RTS map via an I2C switch to TCK/RST in Telos Rev.B
1282 --telos Implies options --invert-reset, --invert-test,
1283 --swap-reset-test, and --telos-latch
1284 --telosb Implies options --swap-reset-test, --telos-i2c,
1285 --no-BSL-download, and --speed=38400
1289 --tmote Identical operation to --telosb
1290 --no-BSL-download Do not download replacement BSL (disable automatic)
1291 --force-BSL-download Download replacement BSL even if not needed (the one
1292 in the device would have the required features)
1293 --slow Add delays when operating the conrol pins. Useful if
1294 the pins/circuit has high capacitance.
1296 Program Flow Specifiers:
1297 -e, --masserase Mass Erase (clear all flash memory)
1298 -E, --erasecheck Erase Check by file
1299 -p, --program Program file
1300 -v, --verify Verify by file
1302 The order of the above options matters! The table is ordered by normal
1303 execution order. For the options "Epv" a file must be specified.
1304 Program flow specifiers default to "pvr" if a file is given.
1305 Don't forget to specify "e" or "eE" when programming flash!
1308 -u, --upload=addr Upload a datablock (see also: -s).
1309 -s, --size=num Size of the data block do upload. (Default is 2)
1310 -x, --hex Show a hexadecimal display of the uploaded data.
1312 -b, --bin Get binary uploaded data. This can be used
1313 to redirect the output into a file.
1316 -g, --go=address Start programm execution at specified address.
1317 This implies option --wait.
1318 -r, --reset Reset connected MSP430. Starts application.
1319 This is a normal device reset and will start
1320 the programm that is specified in the reset
1321 vector. (see also -g)
1322 -w, --wait Wait for <ENTER> before closing serial port.
1324 If it says "NAK received" it's probably because you specified no or a
1326 """ % (sys.argv[0], VERSION))
1328 #add some arguments to a function, but don't call it yet, instead return
1329 #a wrapper object for later invocation
1331 """create a callable with some arguments specified in advance"""
1332 def __init__(self, fun, *args, **kwargs):
1334 self.pending = args[:]
1335 self.kwargs = kwargs.copy()
1337 def __call__(self, *args, **kwargs):
1338 if kwargs and self.kwargs:
1339 kw = self.kwargs.copy()
1342 kw = kwargs or self.kwargs
1343 return apply(self.fun, self.pending + args, kw)
1346 #first try if it a function
1348 return "curry(%s, %r, %r)" % (self.fun.func_name, self.pending, self.kwargs)
1349 except AttributeError:
1350 #fallback for callable classes
1351 return "curry(%s, %r, %r)" % (self.fun, self.pending, self.kwargs)
1353 def hexify(line, bytes, width=16):
1354 return '%04x %s%s %s' % (
1356 ('%02x '*len(bytes)) % tuple(bytes),
1357 ' '* (width-len(bytes)),
1358 ('%c'*len(bytes)) % tuple(map(lambda x: (x>=32 and x<127) and x or ord('.'), bytes))
1367 comPort = None #Default setting.
1371 wait = 0 #wait at the end
1373 bsl = BootStrapLoader()
1387 bsl.invertTEST = itest
1389 if comPort is None and os.environ.get("GOODFET")!=None:
1390 glob_list = glob.glob(os.environ.get("GOODFET"));
1391 if len(glob_list) > 0:
1392 comPort = glob_list[0];
1394 glob_list = glob.glob("/dev/tty.usbserial*");
1395 if len(glob_list) > 0:
1396 comPort = glob_list[0];
1398 glob_list = glob.glob("/dev/ttyUSB*");
1399 if len(glob_list) > 0:
1400 comPort = glob_list[0];
1403 sys.stderr.write("MSP430 Bootstrap Loader Version: %s\n" % VERSION)
1406 opts, args = getopt.getopt(sys.argv[1:],
1407 "hc:P:wf:m:eEpvrg:UDudsxbITNB:S:V14",
1408 ["help", "comport=", "password=", "wait", "framesize=",
1409 "erasecycles=", "masserase", "erasecheck", "program",
1410 "verify", "reset", "go=", "unpatched", "debug",
1411 "upload=", "download=", "size=", "hex", "bin",
1412 "intelhex", "titext", "notimeout", "bsl=", "speed=",
1413 "bslversion", "f1x", "f2x", "f4x", "invert-reset", "invert-test",
1414 "swap-reset-test", "telos-latch", "telos-i2c", "telos", "telosb",
1415 "tmote","no-BSL-download", "force-BSL-download", "slow",
1416 "dumpivt", "dumpinfo", "fromweb",
1417 "goodfet30", "goodfet20", "goodfet10"
1420 except getopt.GetoptError:
1421 # print help information and exit:
1426 if o in ("-h", "--help"):
1429 elif o in ("-c", "--comport"):
1431 comPort = int(a) #try to convert decimal
1433 comPort = a #take the string and let serial driver decide
1434 elif o in ("-P", "--password"):
1435 #extract password from file
1436 bsl.passwd = Memory(a).getMemrange(0xffe0, 0xffff)
1437 elif o in ("-w", "--wait"):
1439 elif o in ("--dumpivt"):
1441 elif o in ("--dumpinfo"):
1443 elif o in ("-f", "--framesize"):
1445 maxData = int(a) #try to convert decimal
1447 sys.stderr.write("framesize must be a valid number\n")
1449 #Make sure that conditions for maxData are met:
1450 #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
1451 if maxData > BootStrapLoader.MAX_DATA_BYTES:
1452 maxData = BootStrapLoader.MAX_DATA_BYTES
1455 bsl.maxData = maxData - (maxData % 16)
1456 sys.stderr.write( "Max. number of data bytes within one frame set to %i.\n" % maxData)
1457 elif o in ("-m", "--erasecycles"):
1459 meraseCycles = int(a) #try to convert decimal
1461 sys.stderr.write("erasecycles must be a valid number\n")
1463 #sanity check of value
1464 if meraseCycles < 1:
1465 sys.stderr.write("erasecycles must be a positive number\n")
1467 if meraseCycles > 20:
1468 sys.stderr.write("warning: erasecycles set to a large number (>20): %d\n" % meraseCycles)
1469 sys.stderr.write( "Number of mass erase cycles set to %i.\n" % meraseCycles)
1470 bsl.meraseCycles = meraseCycles
1471 elif o in ("-e", "--masserase"):
1472 toinit.append(bsl.actionMassErase) #Erase Flash
1473 elif o in ("-E", "--erasecheck"):
1474 toinit.append(bsl.actionEraseCheck) #Erase Check (by file)
1475 elif o in ("-p", "--program"):
1476 todo.append(bsl.actionProgram) #Program file
1477 elif o in ("--fromweb"):
1478 toinit.append(bsl.actionMassErase) #Erase Flash
1479 todo.append(bsl.actionFromweb) #Program GoodFET code
1480 elif o in ("-v", "--verify"):
1481 todo.append(bsl.actionVerify) #Verify file
1482 elif o in ("-r", "--reset"):
1484 elif o in ("-g", "--go"):
1486 goaddr = int(a) #try to convert decimal
1489 goaddr = int(a[2:],16) #try to convert hex
1491 sys.stderr.write("go address must be a valid number\n")
1494 elif o in ("-U", "--unpatched"):
1496 elif o in ("-D", "--debug"):
1498 elif o in ("-u", "--upload"):
1500 startaddr = int(a) #try to convert decimal
1503 startaddr = int(a,16) #try to convert hex
1505 sys.stderr.write("upload address must be a valid number\n")
1507 elif o in ("-s", "--size"):
1514 sys.stderr.write("size must be a valid number\n")
1516 elif o in ("-x", "--hex"):
1518 elif o in ("-b", "--bin"):
1520 elif o in ("-I", "--intelhex"):
1522 elif o in ("-T", "--titext"):
1524 elif o in ("-N", "--notimeout"):
1526 elif o in ("-B", "--bsl"):
1527 bslrepl = Memory() #File to program
1529 elif o in ("-V", "--bslversion"):
1530 todo.append(bsl.actionReadBSLVersion) #load replacement BSL as first item
1531 elif o in ("-S", "--speed"):
1533 speed = int(a) #try to convert decimal
1535 sys.stderr.write("speed must be decimal number\n")
1537 elif o in ("-1", "--f1x"):
1539 elif o in ("-2", "--f2x"):
1541 elif o in ("-4", "--f4x"):
1543 elif o in ("--invert-reset", ):
1545 elif o in ("--invert-test", ):
1547 elif o in ("--swap-reset-test", ):
1549 elif o in ("--telos-latch", ):
1551 elif o in ("--telos-i2c", ):
1553 elif o in ("--telos", ):
1558 elif o in ("--goodfet10", ):
1561 elif o in ("--goodfet20", ):
1564 elif o in ("--goodfet30", ):
1567 elif o in ("--telosb", ):
1572 elif o in ("--tmote", ):
1577 elif o in ("--no-BSL-download", ):
1579 elif o in ("--force-BSL-download", ):
1581 elif o in ("--slow", ):
1585 sys.stderr.write("Use -h for help\n");
1586 sys.stderr.write("Use --fromweb to upgrade a GoodFET.\n")
1587 elif len(args) == 1: #a filename is given
1588 if not todo: #if there are no actions yet
1589 todo.extend([ #add some useful actions...
1594 else: #number of args is wrong
1598 if DEBUG: #debug infos
1599 sys.stderr.write("Debug level set to %d\n" % DEBUG)
1600 sys.stderr.write("Python version: %s\n" % sys.version)
1602 #sanity check of options
1603 if notimeout and goaddr is not None and startaddr is not None:
1604 sys.stderr.write("Option --notimeout can not be used together with both --upload and --go\n")
1608 sys.stderr.write("Warning: option --notimeout can cause improper function in some cases!\n")
1611 if goaddr and reset:
1612 sys.stderr.write("Warning: option --reset ignored as --go is specified!\n")
1615 if startaddr and reset:
1616 sys.stderr.write("Warning: option --reset ignored as --upload is specified!\n")
1621 #prepare data to download
1622 bsl.data = Memory() #prepare downloaded data
1623 if filetype is not None: #if the filetype is given...
1624 if filename is None:
1625 raise ValueError("no filename but filetype specified")
1626 if filename == '-': #get data from stdin
1629 file = open(filename, "rb") #or from a file
1630 if filetype == 0: #select load function
1631 bsl.data.loadIHex(file) #intel hex
1633 bsl.data.loadTIText(file) #TI's format
1635 raise ValueError("illegal filetype specified")
1636 else: #no filetype given...
1637 if filename == '-': #for stdin:
1638 bsl.data.loadIHex(sys.stdin) #assume intel hex
1640 bsl.data.loadFile(filename) #autodetect otherwise
1642 if DEBUG > 3: sys.stderr.write("File: %r" % filename)
1644 bsl.comInit(comPort) #init port
1646 #initialization list
1647 if toinit: #erase and erase check
1648 if DEBUG: sys.stderr.write("Preparing device ...\n")
1649 #bsl.actionStartBSL(usepatch=0, adjsp=0) #no workarounds needed
1650 #if speed: bsl.actionChangeBaudrate(speed) #change baud rate as fast as possible
1651 for f in toinit: f()
1653 if todo or goaddr or startaddr:
1654 if DEBUG: sys.stderr.write("Actions ...\n")
1657 usepatch=not unpatched,
1658 replacementBSL=bslrepl,
1660 mayuseBSL=mayuseBSL,
1666 if DEBUG > 0: #debug
1667 #show a nice list of sheduled actions
1668 sys.stderr.write("TODO list:\n")
1671 sys.stderr.write(" %s\n" % f.func_name)
1672 except AttributeError:
1673 sys.stderr.write(" %r\n" % f)
1674 for f in todo: f() #work through todo list
1676 if reset: #reset device first if desired
1679 bsl.txPasswd(); #default pass
1680 data=bsl.uploadData(0xc00,1024);
1683 hex+=("%02x "%ord(c));
1686 bsl.txPasswd(); #default pass
1687 data=bsl.uploadData(0x1000,256);
1690 hex+=("%02x "%ord(c));
1694 if goaddr is not None: #start user programm at specified address
1695 bsl.actionRun(goaddr) #load PC and execute
1697 #upload datablock and output
1698 if startaddr is not None:
1699 if goaddr: #if a program was started...
1700 #don't restart BSL but wait for the device to enter it itself
1701 sys.stderr.write("Waiting for device to reconnect for upload: ")
1703 bsl.txPasswd(bsl.passwd, wait=1) #synchronize, try forever...
1704 data = bsl.uploadData(startaddr, size) #upload data
1706 data = bsl.uploadData(startaddr, size) #upload data
1707 if hexoutput: #depending on output format
1709 while m < len(data): #print a hex display
1710 print hexify(startaddr+m, map(ord,data[m:m+16]))
1713 sys.stdout.write(data) #binary output w/o newline!
1714 wait = 0 #wait makes no sense as after the upload the device is still in BSL
1716 if wait: #wait at the end if desired
1717 sys.stderr.write("Press <ENTER> ...\n") #display a prompt
1719 raw_input() #wait for newline
1721 bsl.comDone() #Release serial communication port
1723 if __name__ == '__main__':
1727 raise #let pass exit() calls
1728 except KeyboardInterrupt:
1729 if DEBUG: raise #show full trace in debug mode
1730 sys.stderr.write("user abort.\n") #short messy in user mode
1731 sys.exit(1) #set errorlevel for script usage
1732 except Exception, msg: #every Exception is caught and displayed
1733 if DEBUG: raise #show full trace in debug mode
1734 #sys.stderr.write("\nAn error occoured:\n%s\n" % msg) #short messy in user mode
1735 #sys.exit(1) #set errorlevel for script usage