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