summaryrefslogtreecommitdiffstats
path: root/libtoprammer/chips/microchip8/microchip8_common.py
blob: ec0be85a0b4f4bf3f2caca3dc6f079832a122848 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
"""
#    TOP2049 Open Source programming suite
#
#    Microchip8 common - basic file for 8bit PIC MCU
#
#    Copyright (c) 2012 Pavel Stemberk <stemberk@gmail.com>
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License along
#    with this program; if not, write to the Free Software Foundation, Inc.,
#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""

from libtoprammer.chip import *
import math

class Chip_Microchip8_common(Chip):
	CMD_LOAD_DATA_FOR_PGM	 = 0x02
	CMD_LOAD_DATA_FOR_DM	 = 0x03
	CMD_READ_DATA_FROM_PGM	 = 0x04
	CMD_READ_DATA_FROM_DM	 = 0x05
	CMD_INCREMENT_ADDRESS	 = 0x06
	CMD_BULK_ERASE_PGM		 = 0x09
	CMD_BULK_ERASE_DM = 0x0B
	
	PCMDBIT_4BITINSTR 	 = 0
	PCMDBIT_SENDDATA	 = 1
	PCMDBIT_READDATA	 = 2
	
	STAT_BUSY = 0x01
	STAT_SDIO = 0x02

	# EEPROM access: default off, if exists override it
	hasEEPROM = False

	# default delays - can be overridden
	delayTdly5 = 0.00000015
	delayTdis = 0.0001
	delayTprog = 0.001
	delayTdly = 0.000001
	delayTera = 0.01

	def __init__(self,
			chipPackage, chipPinVCC, chipPinsVPP, chipPinGND,
			signature,
			flashPageSize, flashPages,
			eepromPageSize, eepromPages,
			fuseBytes
			):
		Chip.__init__(self,
		chipPackage=chipPackage,
		chipPinVCC=chipPinVCC,
		chipPinsVPP=chipPinsVPP,
		chipPinGND=chipPinGND)
		self.signature = signature
		self.flashPageSize = flashPageSize  # Flash page size, in words
		self.flashPages = flashPages  # Nr of flash pages
		self.eepromPageSize = eepromPageSize  # EEPROM page size, in bytes
		self.eepromPages = eepromPages  # Nr of EEPROM pages
		self.fuseBytes = fuseBytes  # Nr of fuse bytes
		self.PC = 0
		self.isInPmMode = False

	def erase(self):
		if(hasattr(self, 'osccalAddr')):
			self.__erase(keepOSCCAL=True)
		else:
			self.__erase(keepOSCCAL=False)
		
	def __erase(self, keepConfigWord=False, keepUserIDLocation=False, keepOSCCAL=False, keepEEPROM=False):
		OSCCAL = 0xfff
		self.enterPM()
		if(keepOSCCAL):
			self.progressMeterInit("Reading OSCCAL)", 0)
			self.setPC(self.osccalAddr)
			self.sendReadFlashInstr()
			self.top.cmdDelay(self.delayTdly)
			self.readSDOBufferLow()
			self.readSDOBufferHigh()
			OSCCAL = self.top.cmdReadBufferReg16()
			self.progressMeterFinish()
			if(hasattr(self, 'osccalBackupAddr') and OSCCAL == 0xfff):
				self.progressMeterInit("OSCCAL value lost, restoring from backup location ...", 0)
				print("OSCCAL value lost, restoring from backup location ...")
				self.setPC(self.osccalBackupAddr - self.osccalAddr)
				self.sendReadFlashInstr()
				self.top.cmdDelay(self.delayTdly)
				self.readSDOBufferLow()
				self.readSDOBufferHigh()
				OSCCAL = self.top.cmdReadBufferReg16()
				self.progressMeterFinish()
				# print ("osccal: %x\n" % OSCCAL)
		if(keepConfigWord):
			self.progressMeterInit("Reading ConfigWord for backup", 0)
			CW = self.getConfigWord()
			self.progressMeterFinish()
		# erase User ID Location and backup osccal Tooo
		# erase User ID Location and backup osccal Tooo
		if(not keepUserIDLocation):
			self.enterConfigArea()
			self.setPC(self.userIDLocationAddr)
		self.progressMeterInit("Erasing chip", 0)
		self.bulkErasePGM()
		self.progressMeterFinish()
		# OSCCAL=0x3454
		# OSCCAL=0x0C0A
		if(keepOSCCAL and OSCCAL != 0xfff):
			self.exitPM()
			self.enterPM()
			self.progressMeterInit("Writing osccal,  value %x" % OSCCAL, 0)
			print("Writing osccal,  value %x" % OSCCAL)
			self.setPC(self.osccalAddr)
			# print("PC is set to %x" % self.PC)
			self.send6bitWriteInstruction(self.CMD_LOAD_DATA_FOR_PGM, OSCCAL)
			self.top.cmdDelay(self.delayTdly)
			self.sendWriteFlashInstr()
			self.progressMeterFinish()
		if(keepConfigWord):
			self.progressMeterInit("Writing ConfigWord, value %x" % CW, 0)
			self.writeConfigWord(CW)
			self.progressMeterFinish()
		if((not keepEEPROM) and self.hasEEPROM):
			self.progressMeterInit("Erasing EEPROM", 0)
			self.bulkEraseDM()
			self.progressMeterFinish()
		self.exitPM()

	def bulkErasePGM(self):
		self.sendCommand(0, 0, 0, self.CMD_BULK_ERASE_PGM)
		self.top.cmdDelay(self.delayTera)  # Tera
		
	def bulkEraseDM(self):
		self.sendCommand(0, 0, 0, self.CMD_BULK_ERASE_DM)
		self.top.cmdDelay(self.delayTera)  # Tera
		
	def readProgmem(self):	
		nrWords = self.flashPages * self.flashPageSize
		image = ""
		self.enterPM()
		self.setPC(0)
		self.progressMeterInit("Reading flash", nrWords)
		bufferedBytes = 0
		for word in range(0, nrWords):
			self.sendReadFlashInstr()
			# self.top.cmdDelay(0.00002) #20us wait - inconsistent data if skipped
			self.top.cmdDelay(self.delayTdly)
			
			self.readSDOBufferLow()
			bufferedBytes += 1
			self.readSDOBufferHigh()
			bufferedBytes += 1
			if bufferedBytes == self.top.getBufferRegSize():
				image += self.top.cmdReadBufferReg(bufferedBytes)
				self.progressMeter(word)
				bufferedBytes = 0
			self.incrementPC(1)
		image += self.top.cmdReadBufferReg(bufferedBytes)
		self.progressMeterFinish()
		# self.exitPM()
		return image
	
	def readEEPROM(self):	
		nrWords = self.eepromPages * self.eepromPageSize
		image = ""
		self.enterPM()
		self.progressMeterInit("Reading eeprom", nrWords)
		bufferedBytes = 0
		for word in range(0, nrWords):
			self.sendReadEEPROMInstr()
			self.top.cmdDelay(self.delayTdly)  # 20us wait - inconsistent data if skipped
			self.readSDOBufferLow()
			bufferedBytes += 1
			if bufferedBytes == self.top.getBufferRegSize():
				image += self.top.cmdReadBufferReg(bufferedBytes)
				self.progressMeter(word)
				bufferedBytes = 0
			self.incrementPC(1)
		image += self.top.cmdReadBufferReg(bufferedBytes)
		self.progressMeterFinish()
		# self.exitPM()
		return image

	def writeEEPROM(self, image):	
		nrWords = self.eepromPages * self.eepromPageSize
		if len(image) > nrWords:
			self.throwError("Invalid flash image size %d (expected <=%d)" % 	len(image))
		self.enterPM()
		self.progressMeterInit("Writing eeprom", nrWords)
		bufferedBytes = 0
		for addr in range(0, len(image)):
			self.progressMeter(addr)
			byte = byte2int(image[addr])
			if byte != 0xff:
				self.send6bitWriteInstruction(self.CMD_LOAD_DATA_FOR_DM, byte)
				self.top.cmdDelay(self.delayTdly)
				self.sendWriteFlashInstrDM()				
			self.incrementPC(1)
		self.progressMeterFinish()
		# self.exitPM()

	def writeProgmem(self, image):
		nrWords = self.flashPages * self.flashPageSize
		if len(image) > nrWords * 2 or len(image) % 2 != 0:
			self.throwError("Invalid flash image size %d (expected <=%d and word aligned)" % \
				(len(image), nrWords * 2))
		self.progressMeterInit("Writing flash", len(image) // 2)
		self.enterPM()
		self.setPC(0)
		for wordAddr in range(0, len(image) // 2):
			self.progressMeter(wordAddr)
			# do not swap following two lines
			WD = (byte2int(image[wordAddr * 2 + 1]) << 8) | byte2int(image[wordAddr * 2 + 0])
			if(WD != (byte2int(self.defaultWord[1]) << 8) + byte2int(self.defaultWord[0])):
				self.send6bitWriteInstruction(self.CMD_LOAD_DATA_FOR_PGM, WD)
				self.top.cmdDelay(self.delayTdly)				
				self.sendWriteFlashInstr()
			self.incrementPC(1)
		self.progressMeterFinish()
		# self.exitPM()

	def readFuse(self):
		self.enterPM()
		fuses = []
		self.progressMeterInit("Reading fuses (configuration word)", 0)
		for CW in self.getConfigWord(): 
			fuses.append(int2byte(CW & 0x00ff))
			fuses.append(int2byte((CW >> 8) & 0x00ff))
		self.progressMeterFinish()
		return b"".join(fuses)
	
	def readUserIdLocation(self):
		self.enterPM()
		self.enterConfigArea()
		self.setPC(self.userIDLocationAddr)
		self.progressMeterInit("Reading User ID Location", 0)
		for i in range(0, self.userIDLocationSize):
			self.sendReadFlashInstr()
			self.top.hostDelay(self.delayTdly)
			self.readSDOBufferLow()
			self.readSDOBufferHigh()
			self.incrementPC(1)
		# self.exitPM()
		self.progressMeterFinish()
		return self.top.cmdReadBufferReg()[0:2 * self.userIDLocationSize]
	
	def writeUserIdLocation(self, image):
		if len(image) > self.userIDLocationSize * 2 or len(image) % 2 != 0:
			self.throwError("Invalid flash image size %d (expected <=%d and word aligned)" % \
				(len(image), self.userIDLocationSize * 2))
		self.enterPM()
		self.enterConfigArea()
		self.setPC(self.userIDLocationAddr)
		self.progressMeterInit("Writing User ID Location", (len(image) // 2) - 1)
		for word in range(0, (len(image) // 2)):
			self.progressMeter(word)
			# do not swap following two lines
			WD = (byte2int(image[word * 2 + 1]) << 8) | byte2int(image[word * 2 + 0])
			if(WD != (byte2int(self.defaultWord[1]) << 8) + byte2int(self.defaultWord[0])):
				self.send6bitWriteInstruction(self.CMD_LOAD_DATA_FOR_PGM, WD)
				self.sendWriteFlashInstr()
			self.incrementPC(1)
		self.top.hostDelay(self.delayTdly)
		self.sendWriteFlashInstr()
		self.progressMeterFinish()
		# self.exitPM()
		
	def getConfigWordSize(self):
		return self.fuseBytes // 2

	def getConfigWord(self):
		self.enterPM()
		self.enterConfigArea()
		self.setPC(self.configWordAddr)
		retVal = []
		for i in range(0, self.getConfigWordSize()):
			self.sendReadFlashInstr()
			self.top.cmdDelay(self.delayTdly)
			self.readSDOBufferLow()
			self.readSDOBufferHigh()
			self.incrementPC(1)
			retVal.append(self.top.cmdReadBufferReg16())

		return retVal

	def writeFuse(self, image):
		if len(image) != 2 * self.getConfigWordSize():
			self.throwError("Invalid Fuses image size %d (expected %d)" % \
				(len(image), 2 * self.getConfigWordSize()))
		self.progressMeterInit("Writing fuses", 0)
		# print "image1:%x,,%x,,%x" % (byte2int(image[0]),byte2int(image[1]),byte2int(image[1])<<8)
		CW = []
		for tBytes in zip(image[::2], image[1::2]):
			CW.append((byte2int(tBytes[1]) << 8) | byte2int(tBytes[0]))
		self.writeConfigWord(CW)
		self.progressMeterFinish()
    
	def writeConfigWord(self, listConfigWord16):
		# Externally timed writes are not supported
		# for Configuration and Calibration bits. Any
		# externally timed write to the Configuration
		# or Calibration Word will have no effect on
		# the targeted word.
		self.enterPM()
		self.enterConfigArea()
		self.setPC(self.configWordAddr)
		for configWord16 in listConfigWord16:
			# print "write CW {:x}".format(configWord16)
			self.send6bitWriteInstruction(self.CMD_LOAD_DATA_FOR_PGM, configWord16)
			self.top.cmdDelay(self.delayTdly)
			self.sendWriteFlashInstrCW()
			self.incrementPC(1)
		self.top.flushCommands()
					

		
	def enterPM(self):
		if self.isInPmMode and self.isInsideProgramMemoryArea:
			self.resetPC()
			return
		self.PC = self.initPcValue
		self.isInsideProgramMemoryArea = True
		"Enter HV programming mode. Vdd first entry mode"
		self.applyVCC(False)
		self.applyVPP(False)
		self.applyGND(False)
		self.setPins(0, 0)
		self.top.cmdSetVCCVoltage(self.voltageVDD)
		self.top.cmdSetVPPVoltage(self.voltageVPP)
		# self.top.cmdEnableZifPullups(True)
		self.applyGND(True)
		
		self.applyVCC(True)
		# self.top.cmdDelay(0.000005)
		
		for i in range(0, 2):
			self.applyVPP(True)
			# self.top.cmdDelay(0.000005)
			self.applyVPP(False)
			# self.top.cmdDelay(0.000031)
		self.applyVPP(True)
		# self.top.cmdEnableZifPullups(True)
		
		# self.top.cmdDelay(0.000005) #least 5us is required to reach Vdd first entry PM
		self.setTopProgrammerDelays()
		self.isInPmMode = True

	def checkSignature(self):
		signature = self.readSignature()
		if signature != self.signature:
			msg = "Unexpected device signature. " + \
			 "Want %02X%02X%02X, but got %02X%02X%02X" % \
			(byte2int(self.signature[0]), byte2int(self.signature[1]),
			byte2int(self.signature[2]),
			byte2int(signature[0]), byte2int(signature[1]),
			byte2int(signature[2]))
		if self.top.getForceLevel() >= 1:
			self.printWarning(msg)
		else:
			self.throwError(msg)

	def exitPM(self):
		"Exit HV programming mode. Vdd last exit mode"
		self.top.flushCommands()
		self.setPins(0, 0)
		self.applyVPP(False)
		self.applyGND(False)
		self.top.hostDelay(self.delayTdly)
		self.applyVCC(False)
		self.isInPmMode = False

	def sendReadFlashInstr(self):
		'''
		'''
		self.sendCommand(0, 0, 1, self.CMD_READ_DATA_FROM_PGM)

	def sendWriteFlashInstr(self):
		'''
		to be overriden
		'''
		pass
		
	def sendReadEEPROMInstr(self):
		'''
		'''
		self.sendCommand(0, 0, 1, self.CMD_READ_DATA_FROM_DM)

	def send6bitReadInstruction(self, pInstruction):
		def incBbAndCheckFillImage():
			self.BufferedBytes += 1
			if self.BufferedBytes == self.top.getBufferRegSize():
				self.flushBufferToImage()
		# self.sendCommand(1,0,1,pInstruction)
		self.sendCommand(0, 0, 1, pInstruction)
		# self.busyWait()
		self.readSDOBufferHigh()
		incBbAndCheckFillImage()
		
	def send6bitWriteInstruction(self, pInstruction, pDataPayload):
		# self.busyWait()
		self.setSDI(pDataPayload)
		# print("sending {:x}\n".format(pDataPayload))
		self.sendCommand(0, 1, 0, pInstruction)
		self.top.flushCommands()

	def setSDI(self, sdi):
		'''
		set 14 bit sdi value
		'''
		self.top.cmdFPGAWrite(0x13, sdi & 0xFF)
		self.top.cmdFPGAWrite(0x14, (sdi >> 8) & 0x3F)

	def sendCommand(self, bit4bitInstr=0, bitSendData=0, bitReadData=0, cmd4bit=0):
		'''
		`define CMDBIT_4BITINSTR 0
		`define CMDBIT_SENDDATA	1
		`define CMDBIT_READDATA	2
		'''
		command = (cmd4bit & 0x1F) << 3
		if bit4bitInstr:
			command |= 2 ** self.PCMDBIT_4BITINSTR
		if bitSendData:
			command |= 2 ** self.PCMDBIT_SENDDATA
		if bitReadData:
			command |= 2 ** self.PCMDBIT_READDATA
		# print("cmd sending {:x}\n".format(command))
		self.top.cmdFPGAWrite(0x12, command)
		
	def setTopProgrammerDelays(self):
		#print("tdel5:{:d}".format(int(math.ceil(self.delayTdly5 / 42e-9))))
		#print("tdly:{:d}".format(int(math.ceil(self.delayTdly / 42e-9))))
		self.top.cmdFPGAWrite(0x10, int(math.ceil(self.delayTdly5 / 42e-9)))
		self.top.cmdFPGAWrite(0x11, int(math.ceil(self.delayTdly / 42e-9)))

# 	def runCommandSync(self, command):
# 		self.loadCommand(command)
# 		self.busyWait()
	def resetPC(self):
		'''can be overriden'''
		self.setPC(self.initPcValue)
			
	def setPC(self, address):
		'''to be overriden'''
		pass

	def incrementPC(self, count):
		'''to be overriden'''
		pass
	
	def enterConfigArea(self, wordLatched=0):
		'''to be overriden'''
		pass

	def setPins(self, ICSPCLK=0, SDIOVALUE=0, SDIODRIVEN=1):
		'''
		setPins
		'''
		data = 0
		if ICSPCLK:
			data |= 1
		if SDIODRIVEN:
			data |= 2
		if SDIOVALUE:
			data |= 4	    
		self.top.cmdFPGAWrite(0x15, data)

	def getStatusFlags(self):
		'''
		'''
		self.top.cmdFPGARead(0x12)
		stat = self.top.cmdReadBufferReg()
		return byte2int(stat[0])

	def readSDOBufferHigh(self):
		self.top.cmdFPGARead(0x10)
	
	def readSDOBufferLow(self):
		self.top.cmdFPGARead(0x13)	
	
	def rawSDIOState(self):
		return bool(self.getStatusFlags() & self.STAT_SDIO)

	def busy(self):
		return bool(self.getStatusFlags() & self.STAT_BUSY)

# 	def busyWait(self):
# 		for i in range(0, 100):
# 			if not self.busy():
# 				return
# 			self.top.hostDelay(0.01)
# 		self.throwError("Timeout in busywait.")

# 	def waitHighSDIO(self):
# 		for i in range(0, 100):
# 			if self.rawSDOState():
# 				return
# 			self.top.hostDelay(0.01)
# 		self.throwError("Timeout waiting for SDO.")
bues.ch cgit interface