2 STK500v2 protocol implementation for programming AVR chips.
3 The STK500v2 protocol is used by the ArduinoMega2560 and a few other Arduino platforms to load firmware.
5 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
6 import os, struct, sys, time
8 from serial import Serial
9 from serial import SerialException
11 import ispBase, intelHex
13 class Stk500v2(ispBase.IspBase):
18 self.progressCallback = None
20 def connect(self, port = 'COM22', speed = 115200):
21 if self.serial is not None:
24 self.serial = Serial(str(port), speed, timeout=1, writeTimeout=10000)
25 except SerialException as e:
26 raise ispBase.IspError("Failed to open serial port")
28 raise ispBase.IspError("Unexpected error while connecting to serial port:" + port + ":" + str(sys.exc_info()[0]))
32 for n in xrange(0, 2):
33 self.serial.setDTR(True)
35 self.serial.setDTR(False)
39 self.serial.flushInput()
40 self.serial.flushOutput()
42 if self.sendMessage([0x10, 0xc8, 0x64, 0x19, 0x20, 0x00, 0x53, 0x03, 0xac, 0x53, 0x00, 0x00]) != [0x10, 0x00]:
44 raise ispBase.IspError("Failed to enter programming mode")
46 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
47 if self.sendMessage([0xEE])[1] == 0x00:
48 self._has_checksum = True
50 self._has_checksum = False
51 self.serial.timeout = 5
54 if self.serial is not None:
58 #Leave ISP does not reset the serial port, only resets the device, and returns the serial port after disconnecting it from the programming interface.
59 # This allows you to use the serial port without opening it again.
61 if self.serial is not None:
62 if self.sendMessage([0x11]) != [0x11, 0x00]:
63 raise ispBase.IspError("Failed to leave programming mode")
69 def isConnected(self):
70 return self.serial is not None
72 def hasChecksumFunction(self):
73 return self._has_checksum
75 def sendISP(self, data):
76 recv = self.sendMessage([0x1D, 4, 4, 0, data[0], data[1], data[2], data[3]])
79 def writeFlash(self, flashData):
80 #Set load addr to 0, in case we have more then 64k flash we need to enable the address extension
81 pageSize = self.chip['pageSize'] * 2
82 flashSize = pageSize * self.chip['pageCount']
83 if flashSize > 0xFFFF:
84 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
86 self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
88 loadCount = (len(flashData) + pageSize - 1) / pageSize
89 for i in xrange(0, loadCount):
90 recv = self.sendMessage([0x13, pageSize >> 8, pageSize & 0xFF, 0xc1, 0x0a, 0x40, 0x4c, 0x20, 0x00, 0x00] + flashData[(i * pageSize):(i * pageSize + pageSize)])
91 if self.progressCallback is not None:
92 if self._has_checksum:
93 self.progressCallback(i + 1, loadCount)
95 self.progressCallback(i + 1, loadCount*2)
97 def verifyFlash(self, flashData):
98 if self._has_checksum:
99 self.sendMessage([0x06, 0x00, (len(flashData) >> 17) & 0xFF, (len(flashData) >> 9) & 0xFF, (len(flashData) >> 1) & 0xFF])
100 res = self.sendMessage([0xEE])
101 checksum_recv = res[2] | (res[3] << 8)
106 if hex(checksum) != hex(checksum_recv):
107 raise ispBase.IspError('Verify checksum mismatch: 0x%x != 0x%x' % (checksum & 0xFFFF, checksum_recv))
109 #Set load addr to 0, in case we have more then 64k flash we need to enable the address extension
110 flashSize = self.chip['pageSize'] * 2 * self.chip['pageCount']
111 if flashSize > 0xFFFF:
112 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
114 self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
116 loadCount = (len(flashData) + 0xFF) / 0x100
117 for i in xrange(0, loadCount):
118 recv = self.sendMessage([0x14, 0x01, 0x00, 0x20])[2:0x102]
119 if self.progressCallback is not None:
120 self.progressCallback(loadCount + i + 1, loadCount*2)
121 for j in xrange(0, 0x100):
122 if i * 0x100 + j < len(flashData) and flashData[i * 0x100 + j] != recv[j]:
123 raise ispBase.IspError('Verify error at: 0x%x' % (i * 0x100 + j))
125 def sendMessage(self, data):
126 message = struct.pack(">BBHB", 0x1B, self.seq, len(data), 0x0E)
128 message += struct.pack(">B", c)
132 message += struct.pack(">B", checksum)
134 self.serial.write(message)
136 except Serial.SerialTimeoutException:
137 raise ispBase.IspError('Serial send timeout')
138 self.seq = (self.seq + 1) & 0xFF
139 return self.recvMessage()
141 def recvMessage(self):
145 s = self.serial.read()
147 raise ispBase.IspError("Timeout")
148 b = struct.unpack(">B", s)[0]
155 elif state == 'GetSeq':
157 elif state == 'MsgSize1':
160 elif state == 'MsgSize2':
163 elif state == 'Token':
169 elif state == 'Data':
171 if len(data) == msgSize:
173 elif state == 'Checksum':
182 key=_winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,"HARDWARE\\DEVICEMAP\\SERIALCOMM")
186 values = _winreg.EnumValue(key, i)
189 if 'USBSER' in values[0]:
190 ret.append(values[1])
194 def runProgrammer(port, filename):
195 """ Run an STK500v2 program on serial port 'port' and write 'filename' into flash. """
196 programmer = Stk500v2()
197 programmer.connect(port = port)
198 programmer.programChip(intelHex.readHex(filename))
202 """ Entry point to call the stk500v2 programmer from the commandline. """
204 if sys.argv[1] == 'AUTO':
206 for port in portList():
207 threading.Thread(target=runProgrammer, args=(port,sys.argv[2])).start()
210 programmer = Stk500v2()
211 programmer.connect(port = sys.argv[1])
212 programmer.programChip(intelHex.readHex(sys.argv[2]))
215 if __name__ == '__main__':