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 from serial import SerialTimeoutException
  11
  12 import ispBase, intelHex
  13
  14 class Stk500v2(ispBase.IspBase):
  15         def __init__(self):
  16                 self.serial = None
  17                 self.seq = 1
  18                 self.lastAddr = -1
  19                 self.progressCallback = None
  20
  21         def connect(self, port = 'COM22', speed = 115200):
  22                 if self.serial is not None:
  23                         self.close()
  24                 try:
  25                         self.serial = Serial(str(port), speed, timeout=1, writeTimeout=10000)
  26                 except SerialException as e:
  27                         raise ispBase.IspError("Failed to open serial port")
  28                 except:
  29                         raise ispBase.IspError("Unexpected error while connecting to serial port:" + port + ":" + str(sys.exc_info()[0]))
  30                 self.seq = 1
  31
  32                 #Reset the controller
  33                 for n in xrange(0, 2):
  34                         self.serial.setDTR(True)
  35                         time.sleep(0.1)
  36                         self.serial.setDTR(False)
  37                         time.sleep(0.1)
  38                 time.sleep(0.2)
  39
  40                 self.serial.flushInput()
  41                 self.serial.flushOutput()
  42                 self.sendMessage([1])
  43                 if self.sendMessage([0x10, 0xc8, 0x64, 0x19, 0x20, 0x00, 0x53, 0x03, 0xac, 0x53, 0x00, 0x00]) != [0x10, 0x00]:
  44                         self.close()
  45                         raise ispBase.IspError("Failed to enter programming mode")
  46
  47                 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
  48                 if self.sendMessage([0xEE])[1] == 0x00:
  49                         self._has_checksum = True
  50                 else:
  51                         self._has_checksum = False
  52                 self.serial.timeout = 5
  53
  54         def close(self):
  55                 if self.serial is not None:
  56                         self.serial.close()
  57                         self.serial = None
  58
  59         #Leave ISP does not reset the serial port, only resets the device, and returns the serial port after disconnecting it from the programming interface.
  60         #       This allows you to use the serial port without opening it again.
  61         def leaveISP(self):
  62                 if self.serial is not None:
  63                         if self.sendMessage([0x11]) != [0x11, 0x00]:
  64                                 raise ispBase.IspError("Failed to leave programming mode")
  65                         ret = self.serial
  66                         self.serial = None
  67                         return ret
  68                 return None
  69
  70         def isConnected(self):
  71                 return self.serial is not None
  72
  73         def hasChecksumFunction(self):
  74                 return self._has_checksum
  75
  76         def sendISP(self, data):
  77                 recv = self.sendMessage([0x1D, 4, 4, 0, data[0], data[1], data[2], data[3]])
  78                 return recv[2:6]
  79
  80         def writeFlash(self, flashData):
  81                 #Set load addr to 0, in case we have more then 64k flash we need to enable the address extension
  82                 pageSize = self.chip['pageSize'] * 2
  83                 flashSize = pageSize * self.chip['pageCount']
  84                 if flashSize > 0xFFFF:
  85                         self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
  86                 else:
  87                         self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
  88
  89                 loadCount = (len(flashData) + pageSize - 1) / pageSize
  90                 for i in xrange(0, loadCount):
  91                         recv = self.sendMessage([0x13, pageSize >> 8, pageSize & 0xFF, 0xc1, 0x0a, 0x40, 0x4c, 0x20, 0x00, 0x00] + flashData[(i * pageSize):(i * pageSize + pageSize)])
  92                         if self.progressCallback is not None:
  93                                 if self._has_checksum:
  94                                         self.progressCallback(i + 1, loadCount)
  95                                 else:
  96                                         self.progressCallback(i + 1, loadCount*2)
  97
  98         def verifyFlash(self, flashData):
  99                 if self._has_checksum:
 100                         self.sendMessage([0x06, 0x00, (len(flashData) >> 17) & 0xFF, (len(flashData) >> 9) & 0xFF, (len(flashData) >> 1) & 0xFF])
 101                         res = self.sendMessage([0xEE])
 102                         checksum_recv = res[2] | (res[3] << 8)
 103                         checksum = 0
 104                         for d in flashData:
 105                                 checksum += d
 106                         checksum &= 0xFFFF
 107                         if hex(checksum) != hex(checksum_recv):
 108                                 raise ispBase.IspError('Verify checksum mismatch: 0x%x != 0x%x' % (checksum & 0xFFFF, checksum_recv))
 109                 else:
 110                         #Set load addr to 0, in case we have more then 64k flash we need to enable the address extension
 111                         flashSize = self.chip['pageSize'] * 2 * self.chip['pageCount']
 112                         if flashSize > 0xFFFF:
 113                                 self.sendMessage([0x06, 0x80, 0x00, 0x00, 0x00])
 114                         else:
 115                                 self.sendMessage([0x06, 0x00, 0x00, 0x00, 0x00])
 116
 117                         loadCount = (len(flashData) + 0xFF) / 0x100
 118                         for i in xrange(0, loadCount):
 119                                 recv = self.sendMessage([0x14, 0x01, 0x00, 0x20])[2:0x102]
 120                                 if self.progressCallback is not None:
 121                                         self.progressCallback(loadCount + i + 1, loadCount*2)
 122                                 for j in xrange(0, 0x100):
 123                                         if i * 0x100 + j < len(flashData) and flashData[i * 0x100 + j] != recv[j]:
 124                                                 raise ispBase.IspError('Verify error at: 0x%x' % (i * 0x100 + j))
 125
 126         def sendMessage(self, data):
 127                 message = struct.pack(">BBHB", 0x1B, self.seq, len(data), 0x0E)
 128                 for c in data:
 129                         message += struct.pack(">B", c)
 130                 checksum = 0
 131                 for c in message:
 132                         checksum ^= ord(c)
 133                 message += struct.pack(">B", checksum)
 134                 try:
 135                         self.serial.write(message)
 136                         self.serial.flush()
 137                 except SerialTimeoutException:
 138                         raise ispBase.IspError('Serial send timeout')
 139                 self.seq = (self.seq + 1) & 0xFF
 140                 return self.recvMessage()
 141
 142         def recvMessage(self):
 143                 state = 'Start'
 144                 checksum = 0
 145                 while True:
 146                         s = self.serial.read()
 147                         if len(s) < 1:
 148                                 raise ispBase.IspError("Timeout")
 149                         b = struct.unpack(">B", s)[0]
 150                         checksum ^= b
 151                         #print(hex(b))
 152                         if state == 'Start':
 153                                 if b == 0x1B:
 154                                         state = 'GetSeq'
 155                                         checksum = 0x1B
 156                         elif state == 'GetSeq':
 157                                 state = 'MsgSize1'
 158                         elif state == 'MsgSize1':
 159                                 msgSize = b << 8
 160                                 state = 'MsgSize2'
 161                         elif state == 'MsgSize2':
 162                                 msgSize |= b
 163                                 state = 'Token'
 164                         elif state == 'Token':
 165                                 if b != 0x0E:
 166                                         state = 'Start'
 167                                 else:
 168                                         state = 'Data'
 169                                         data = []
 170                         elif state == 'Data':
 171                                 data.append(b)
 172                                 if len(data) == msgSize:
 173                                         state = 'Checksum'
 174                         elif state == 'Checksum':
 175                                 if checksum != 0:
 176                                         state = 'Start'
 177                                 else:
 178                                         return data
 179
 180 def portList():
 181         ret = []
 182         import _winreg
 183         key=_winreg.OpenKey(_winreg.HKEY_LOCAL_MACHINE,"HARDWARE\\DEVICEMAP\\SERIALCOMM")
 184         i=0
 185         while True:
 186                 try:
 187                         values = _winreg.EnumValue(key, i)
 188                 except:
 189                         return ret
 190                 if 'USBSER' in values[0]:
 191                         ret.append(values[1])
 192                 i+=1
 193         return ret
 194
 195 def runProgrammer(port, filename):
 196         """ Run an STK500v2 program on serial port 'port' and write 'filename' into flash. """
 197         programmer = Stk500v2()
 198         programmer.connect(port = port)
 199         programmer.programChip(intelHex.readHex(filename))
 200         programmer.close()
 201
 202 def main():
 203         """ Entry point to call the stk500v2 programmer from the commandline. """
 204         import threading
 205         if sys.argv[1] == 'AUTO':
 206                 print portList()
 207                 for port in portList():
 208                         threading.Thread(target=runProgrammer, args=(port,sys.argv[2])).start()
 209                         time.sleep(5)
 210         else:
 211                 programmer = Stk500v2()
 212                 programmer.connect(port = sys.argv[1])
 213                 programmer.programChip(intelHex.readHex(sys.argv[2]))
 214                 sys.exit(1)
 215
 216 if __name__ == '__main__':
 217         main()