Cura/avr_isp/stk500v2.py

   1 """
   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.
   4 """
   5 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
   6 import os, struct, sys, time
   7
   8 from serial import Serial
   9 from serial import SerialException
  10
  11 import ispBase, intelHex
  12
  13 class Stk500v2(ispBase.IspBase):
  14         def __init__(self):
  15                 self.serial = None
  16                 self.seq = 1
  17                 self.lastAddr = -1
  18                 self.progressCallback = None
  19
  20         def connect(self, port = 'COM22', speed = 115200):
  21                 if self.serial is not None:
  22                         self.close()
  23                 try:
  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")
  27                 except:
  28                         raise ispBase.IspError("Unexpected error while connecting to serial port:" + port + ":" + str(sys.exc_info()[0]))
  29                 self.seq = 1
  30
  31                 #Reset the controller
  32                 for n in xrange(0, 2):
  33                         self.serial.setDTR(True)
  34                         time.sleep(0.1)
  35                         self.serial.setDTR(False)
  36                         time.sleep(0.1)
  37                 time.sleep(0.2)
  38
  39                 self.serial.flushInput()
  40                 self.serial.flushOutput()
  41                 self.sendMessage([1])
  42                 if self.sendMessage([0x10, 0xc8, 0x64, 0x19, 0x20, 0x00, 0x53, 0x03, 0xac, 0x53, 0x00, 0x00]) != [0x10, 0x00]:
  43                         self.close()
  44                         raise ispBase.IspError("Failed to enter programming mode")
  45
  46                 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
  47                 if self.sendMessage([0xEE])[1] == 0x00:
  48                         self._has_checksum = True
  49                 else:
  50                         self._has_checksum = False
  51                 self.serial.timeout = 5
  52
  53         def close(self):
  54                 if self.serial is not None:
  55                         self.serial.close()
  56                         self.serial = None
  57
  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.
  60         def leaveISP(self):
  61                 if self.serial is not None:
  62                         if self.sendMessage([0x11]) != [0x11, 0x00]:
  63                                 raise ispBase.IspError("Failed to leave programming mode")
  64                         ret = self.serial
  65                         self.serial = None
  66                         return ret
  67                 return None
  68
  69         def isConnected(self):
  70                 return self.serial is not None
  71
  72         def hasChecksumFunction(self):
  73                 return self._has_checksum
  74
  75         def sendISP(self, data):
  76                 recv = self.sendMessage([0x1D, 4, 4, 0, data[0], data[1], data[2], data[3]])
  77                 return recv[2:6]
  78
  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])
  85                 else:
  86                         self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
  87
  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)
  94                                 else:
  95                                         self.progressCallback(i + 1, loadCount*2)
  96
  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)
 102                         checksum = 0
 103                         for d in flashData:
 104                                 checksum += d
 105                         checksum &= 0xFFFF
 106                         if hex(checksum) != hex(checksum_recv):
 107                                 raise ispBase.IspError('Verify checksum mismatch: 0x%x != 0x%x' % (checksum & 0xFFFF, checksum_recv))
 108                 else:
 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])
 113                         else:
 114                                 self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
 115
 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))
 124
 125         def sendMessage(self, data):
 126                 message = struct.pack(">BBHB", 0x1B, self.seq, len(data), 0x0E)
 127                 for c in data:
 128                         message += struct.pack(">B", c)
 129                 checksum = 0
 130                 for c in message:
 131                         checksum ^= ord(c)
 132                 message += struct.pack(">B", checksum)
 133                 try:
 134                         self.serial.write(message)
 135                         self.serial.flush()
 136                 except Serial.SerialTimeoutException:
 137                         raise ispBase.IspError('Serial send timeout')
 138                 self.seq = (self.seq + 1) & 0xFF
 139                 return self.recvMessage()
 140
 141         def recvMessage(self):
 142                 state = 'Start'
 143                 checksum = 0
 144                 while True:
 145                         s = self.serial.read()
 146                         if len(s) < 1:
 147                                 raise ispBase.IspError("Timeout")
 148                         b = struct.unpack(">B", s)[0]
 149                         checksum ^= b
 150                         #print(hex(b))
 151                         if state == 'Start':
 152                                 if b == 0x1B:
 153                                         state = 'GetSeq'
 154                                         checksum = 0x1B
 155                         elif state == 'GetSeq':
 156                                 state = 'MsgSize1'
 157                         elif state == 'MsgSize1':
 158                                 msgSize = b << 8
 159                                 state = 'MsgSize2'
 160                         elif state == 'MsgSize2':
 161                                 msgSize |= b
 162                                 state = 'Token'
 163                         elif state == 'Token':
 164                                 if b != 0x0E:
 165                                         state = 'Start'
 166                                 else:
 167                                         state = 'Data'
 168                                         data = []
 169                         elif state == 'Data':
 170                                 data.append(b)
 171                                 if len(data) == msgSize:
 172                                         state = 'Checksum'
 173                         elif state == 'Checksum':
 174                                 if checksum != 0:
 175                                         state = 'Start'
 176                                 else:
 177                                         return data
 178
 179 def portList():
 180         ret = []
 181         import _winreg
 182         key=_winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,"HARDWARE\\DEVICEMAP\\SERIALCOMM")
 183         i=0
 184         while True:
 185                 try:
 186                         values = _winreg.EnumValue(key, i)
 187                 except:
 188                         return ret
 189                 if 'USBSER' in values[0]:
 190                         ret.append(values[1])
 191                 i+=1
 192         return ret
 193
 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))
 199         programmer.close()
 200
 201 def main():
 202         """ Entry point to call the stk500v2 programmer from the commandline. """
 203         import threading
 204         if sys.argv[1] == 'AUTO':
 205                 print portList()
 206                 for port in portList():
 207                         threading.Thread(target=runProgrammer, args=(port,sys.argv[2])).start()
 208                         time.sleep(5)
 209         else:
 210                 programmer = Stk500v2()
 211                 programmer.connect(port = sys.argv[1])
 212                 programmer.programChip(intelHex.readHex(sys.argv[2]))
 213                 sys.exit(1)
 214
 215 if __name__ == '__main__':
 216         main()