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
|
"""
# TOP2049 Open Source programming suite
#
# Chip support
#
# Copyright (c) 2009-2010 Michael Buesch <mb@bu3sch.de>
#
# 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 util import *
from layout_generator import *
class Chip:
def __init__(self, chipPackage=None, chipPinVCCX=None, chipPinsVPP=None, chipPinGND=None):
"""chipPackage is the ID string for the package.
May be None, if no initial auto-layout is required.
chipPinVCCX is the required VCCX pin on the package.
chipPinVPP is the required VPP pin on the package.
chipPinGND is the required GND pin on the package."""
self.printPrefix = True
if chipPackage:
# Initialize auto-layout
self.regenerateVoltageLayouts(chipPackage=chipPackage,
chipPinVCCX=chipPinVCCX,
chipPinsVPP=chipPinsVPP,
chipPinGND=chipPinGND)
def setTOP(self, top):
self.top = top
def setChipID(self, chipID):
self.chipID = chipID
def printWarning(self, message, newline=True):
if self.printPrefix:
message = self.chipID + ": " + message
self.top.printWarning(message, newline)
self.printPrefix = newline
def printInfo(self, message, newline=True):
if self.printPrefix:
message = self.chipID + ": " + message
self.top.printInfo(message, newline)
self.printPrefix = newline
def printDebug(self, message, newline=True):
if self.printPrefix:
message = self.chipID + ": " + message
self.top.printDebug(message, newline)
self.printPrefix = newline
def throwError(self, message):
raise TOPException(self.chipID + ": " + message)
def regenerateVoltageLayouts(self, chipPackage, chipPinVCCX, chipPinsVPP, chipPinGND):
"""Regenerate and initialize the autogenerated
VCCX, VPP and GND layouts. This initializes the layouts that can later
be applied using applyVCCX(), applyVPP() and applyGND()."""
self.generator = createLayoutGenerator(chipPackage)
self.generator.setProgrammerType("TOP2049")#XXX Currently the only supported programmer
self.generator.setPins(vccxPin=chipPinVCCX,
vppPins=chipPinsVPP,
gndPin=chipPinGND)
self.generator.recalculate()
def applyVCCX(self, turnOn):
"Turn VCCX on, using the auto-layout."
if turnOn:
try:
generator = self.generator
except (AttributeError), e:
self.throwError("BUG: Using auto-layout, but did not initialize it.")
generator.applyVCCXLayout(self.top)
else:
self.top.vccx.setLayoutMask(0)
def applyVPP(self, turnOn):
"Turn VPP on, using the auto-layout."
if turnOn:
try:
generator = self.generator
except (AttributeError), e:
self.throwError("BUG: Using auto-layout, but did not initialize it.")
generator.applyVPPLayout(self.top)
else:
self.top.vpp.setLayoutMask(0)
def applyGND(self, turnOn):
"Turn GND on, using the auto-layout."
if turnOn:
try:
generator = self.generator
except (AttributeError), e:
self.throwError("BUG: Using auto-layout, but did not initialize it.")
generator.applyGNDLayout(self.top)
else:
self.top.gnd.setLayoutMask(0)
def progressMeterInit(self, message, nrSteps):
self.progressNrSteps = nrSteps
self.progressHave25 = False
self.progressHave50 = False
self.progressHave75 = False
self.printInfo(message + " [0%", newline=False)
def progressMeterFinish(self):
if not self.progressNrSteps:
self.printInfo("...", newline=False)
self.printInfo("100%]")
def progressMeter(self, step):
if step % (self.progressNrSteps // 32) == 0:
percent = (step * 100 // self.progressNrSteps)
if percent >= 25 and not self.progressHave25:
self.printInfo("25%", newline=False)
self.progressHave25 = True
elif percent >= 50 and not self.progressHave50:
self.printInfo("50%", newline=False)
self.progressHave50 = True
elif percent >= 75 and not self.progressHave75:
self.printInfo("75%", newline=False)
self.progressHave75 = True
else:
self.printInfo(".", newline=False)
def initializeChip(self):
pass # Override me in the subclass, if required.
def shutdownChip(self):
pass # Override me in the subclass, if required.
def readSignature(self):
# Override me in the subclass, if required.
raise TOPException("Signature reading not supported on " + self.chipID)
def erase(self):
# Override me in the subclass, if required.
raise TOPException("Chip erasing not supported on " + self.chipID)
def readProgmem(self):
# Override me in the subclass, if required.
raise TOPException("Program memory reading not supported on " + self.chipID)
def writeProgmem(self, image):
# Override me in the subclass, if required.
raise TOPException("Program memory writing not supported on " + self.chipID)
def readEEPROM(self):
# Override me in the subclass, if required.
raise TOPException("EEPROM reading not supported on " + self.chipID)
def writeEEPROM(self, image):
# Override me in the subclass, if required.
raise TOPException("EEPROM writing not supported on " + self.chipID)
def readFuse(self):
# Override me in the subclass, if required.
raise TOPException("Fuse reading not supported on " + self.chipID)
def writeFuse(self, image):
# Override me in the subclass, if required.
raise TOPException("Fuse writing not supported on " + self.chipID)
def readLockbits(self):
# Override me in the subclass, if required.
raise TOPException("Lockbit reading not supported on " + self.chipID)
def writeLockbits(self, image):
# Override me in the subclass, if required.
raise TOPException("Lockbit writing not supported on " + self.chipID)
registeredChips = []
class RegisteredChip:
def __init__(self, chipImplClass, bitfile,
description="", packages=None, comment="",
broken=False):
"""Register a chip implementation class.
chipImplClass => The implementation class of the chip.
bitfile => The bitfile ID of the chip.
description => Human readable chip description string.
packages => List of supported packages.
Each entry is a tuple of two strings: ("PACKAGE", "description")
comment => Additional comment string.
broken => Boolean flag to mark the implementation as broken.
"""
self.chipImplClass = chipImplClass
self.bitfile = bitfile
self.description = description
self.packages = packages
self.comment = comment
self.broken = broken
registeredChips.append(self)
@staticmethod
def find(chipID, allowBroken=False):
"Find a chip implementation by ID and return an instance of it."
for chip in registeredChips:
if chip.broken and not allowBroken:
continue
if chip.bitfile.lower() == chipID.lower():
instance = chip.chipImplClass()
instance.setChipID(chip.bitfile)
return instance
return None
@staticmethod
def dumpAll(fd, verbose=1, showBroken=True):
"Dump all supported chips to file fd."
count = 0
for chip in registeredChips:
if chip.broken and not showBroken:
continue
count = count + 1
if count >= 2:
fd.write("\n")
chip.dump(fd, verbose)
def dump(self, fd, verbose=1):
"Dump information about a registered chip to file fd."
if self.description:
fd.write(self.description)
else:
fd.write(self.bitfile)
if self.broken:
fd.write(" (broken implementation)")
fd.write("\n")
fd.write("%25s: %s\n" % ("BIT-file", self.bitfile))
if verbose >= 3 and self.packages:
for (package, description) in self.packages:
if description:
description = " (" + description + ")"
fd.write("%25s: %s%s\n" % ("Supported package", package, description))
if verbose >= 4:
supportedFeatures = (
("erase", "Full chip erase"),
("readSignature", "Chip signature reading"),
("readProgmem", "Program memory reading (flash)"),
("writeProgmem", "Program memory writing (flash)"),
("readEEPROM", "(E)EPROM memory reading"),
("writeEEPROM", "(E)EPROM memory writing"),
("readFuse", "Fuse bits reading"),
("writeFuse", "Fuse bits writing"),
("readLockbits", "Lock bits reading"),
("writeLockbits", "Lock bits writing"),
)
for (attr, description) in supportedFeatures:
if getattr(self.chipImplClass, attr) != getattr(Chip, attr):
fd.write("%25s: %s\n" % ("Support for", description))
if verbose >= 2 and self.comment:
fd.write("%25s: %s\n" % ("Comment", self.comment))
|
