2 # GoodFET Client Library
4 # (C) 2009 Travis Goodspeed <travis at radiantmachines.com>
6 # This code is being rewritten and refactored. You've been warned!
8 import sys, time, string, cStringIO, struct, glob, serial, os;
11 fmt = ("B", "<H", None, "<L")
13 def getClient(name="GoodFET"):
14 import GoodFET, GoodFETCC, GoodFETAVR, GoodFETSPI, GoodFETMSP430, GoodFETNRF;
15 if(name=="GoodFET" or name=="monitor"): return GoodFET.GoodFET();
16 elif name=="cc" or name=="cc51": return GoodFETCC.GoodFETCC();
17 elif name=="cc2420" or name=="ccspi": return GoodFETCC.GoodFETCC();
18 elif name=="avr": return GoodFETAVR.GoodFETAVR();
19 elif name=="spi": return GoodFETSPI.GoodFETSPI();
20 elif name=="msp430": return GoodFETMSP430.GoodFETMSP430();
21 elif name=="nrf": return GoodFETNRF.GoodFETNRF();
23 print "Unsupported target: %s" % name;
27 """GoodFET Symbol Table"""
28 db=sqlite3.connect(":memory:");
30 def __init__(self, *args, **kargs):
31 self.db.execute("create table if not exists symbols(adr,name,memory,size,comment);");
36 c.execute("select adr,memory from symbols where name=?",(name,));
42 except:# sqlite3.OperationalError:
46 def define(self,adr,name,comment="",memory="vn",size=16):
47 self.db.execute("insert into symbols(adr,name,memory,size,comment)"
48 "values(?,?,?,?,?);", (
49 adr,name,memory,size,comment));
50 #print "Set %s=%s." % (name,adr);
53 """GoodFET Client Library"""
64 symbols=SymbolTable();
66 def __init__(self, *args, **kargs):
69 from GoodFETConsole import GoodFETConsole;
70 return GoodFETConsole(self);
71 def name2adr(self,name):
72 return self.symbols.get(name);
75 def serInit(self, port=None, timeout=2):
76 """Open the serial port"""
77 # Make timeout None to wait forever, 0 for non-blocking mode.
79 if port is None and os.environ.get("GOODFET")!=None:
80 glob_list = glob.glob(os.environ.get("GOODFET"));
81 if len(glob_list) > 0:
84 port = os.environ.get("GOODFET");
86 glob_list = glob.glob("/dev/tty.usbserial*");
87 if len(glob_list) > 0:
90 glob_list = glob.glob("/dev/ttyUSB*");
91 if len(glob_list) > 0:
94 from scanwin32 import winScan;
96 for order,comport,desc,hwid in sorted(scan.comports()):
98 if hwid.index('FTDI')==0:
100 #print "Using FTDI port %s" % port
105 self.serialport = serial.Serial(
109 parity = serial.PARITY_NONE,
117 while self.verb!=0x7F or self.data!="http://goodfet.sf.net/":
119 self.serialport.flushInput()
120 self.serialport.flushOutput()
121 #Explicitly set RTS and DTR to halt board.
122 self.serialport.setRTS(1);
123 self.serialport.setDTR(1);
124 #Drop DTR, which is !RST, low to begin the app.
125 self.serialport.setDTR(0);
127 #TelosB reset, prefer software to I2C SPST Switch.
128 if(os.environ.get("platform")=='telosb'):
130 #self.serialport.write(chr(0x80));
131 #self.serialport.write(chr(0x80));
132 #self.serialport.write(chr(0x80));
133 #self.serialport.write(chr(0x80));
136 self.serialport.flushInput()
137 self.serialport.flushOutput()
140 self.readcmd(); #Read the first command.
141 #Here we have a connection, but maybe not a good one.
143 olds=self.infostring();
144 clocking=self.monitorclocking();
145 for foo in range(1,30):
146 if not self.monitorecho():
147 if self.verbose: print "Comm error on %i try, resyncing out of %s." % (foo,
151 if self.verbose: print "Connected after %02i attempts." % attempts;
152 self.mon_connected();
153 def telosSetSCL(self, level):
154 self.serialport.setRTS(not level)
155 def telosSetSDA(self, level):
156 self.serialport.setDTR(not level)
158 def telosI2CStart(self):
163 def telosI2CStop(self):
168 def telosI2CWriteBit(self, bit):
170 self.telosSetSDA(bit)
176 def telosI2CWriteByte(self, byte):
177 self.telosI2CWriteBit( byte & 0x80 );
178 self.telosI2CWriteBit( byte & 0x40 );
179 self.telosI2CWriteBit( byte & 0x20 );
180 self.telosI2CWriteBit( byte & 0x10 );
181 self.telosI2CWriteBit( byte & 0x08 );
182 self.telosI2CWriteBit( byte & 0x04 );
183 self.telosI2CWriteBit( byte & 0x02 );
184 self.telosI2CWriteBit( byte & 0x01 );
185 self.telosI2CWriteBit( 0 ); # "acknowledge"
187 def telosI2CWriteCmd(self, addr, cmdbyte):
189 self.telosI2CWriteByte( 0x90 | (addr << 1) )
190 self.telosI2CWriteByte( cmdbyte )
193 def telosBReset(self,invokeBSL=0):
194 # "BSL entry sequence at dedicated JTAG pins"
195 # rst !s0: 0 0 0 0 1 1
196 # tck !s1: 1 0 1 0 0 1
199 # "BSL entry sequence at shared JTAG pins"
200 # rst !s0: 0 0 0 0 1 1
201 # tck !s1: 0 1 0 1 1 0
205 self.telosI2CWriteCmd(0,1)
206 self.telosI2CWriteCmd(0,3)
207 self.telosI2CWriteCmd(0,1)
208 self.telosI2CWriteCmd(0,3)
209 self.telosI2CWriteCmd(0,2)
210 self.telosI2CWriteCmd(0,0)
212 self.telosI2CWriteCmd(0,3)
213 self.telosI2CWriteCmd(0,2)
215 # This line was not defined inside the else: block, not sure where it
217 self.telosI2CWriteCmd(0,0)
218 time.sleep(0.250) #give MSP430's oscillator time to stabilize
219 self.serialport.flushInput() #clear buffers
222 def getbuffer(self,size=0x1c00):
223 writecmd(0,0xC2,[size&0xFF,(size>>16)&0xFF]);
224 print "Got %02x%02x buffer size." % (self.data[1],self.data[0]);
225 def writecmd(self, app, verb, count=0, data=[]):
226 """Write a command and some data to the GoodFET."""
227 self.serialport.write(chr(app));
228 self.serialport.write(chr(verb));
231 # count=len(data); #Initial count ignored.
233 #print "TX %02x %02x %04x" % (app,verb,count);
235 #little endian 16-bit length
236 self.serialport.write(chr(count&0xFF));
237 self.serialport.write(chr(count>>8));
240 print "Tx: ( 0x%02x, 0x%02x, 0x%04x )" % ( app, verb, count )
242 #print "count=%02x, len(data)=%04x" % (count,len(data));
245 if(isinstance(data,list)):
246 for i in range(0,count):
247 #print "Converting %02x at %i" % (data[i],i)
248 data[i]=chr(data[i]);
250 outstr=''.join(data);
251 self.serialport.write(outstr);
252 if not self.besilent:
253 return self.readcmd()
258 """Read a reply from the GoodFET."""
259 while 1:#self.serialport.inWaiting(): # Loop while input data is available
262 self.app=ord(self.serialport.read(1));
263 #print "APP=%2x" % self.app;
264 self.verb=ord(self.serialport.read(1));
265 #print "VERB=%02x" % self.verb;
267 ord(self.serialport.read(1))
268 +(ord(self.serialport.read(1))<<8)
272 print "Rx: ( 0x%02x, 0x%02x, 0x%04x )" % ( self.app, self.verb, self.count )
274 #Debugging string; print, but wait.
277 print "# DEBUG %s" % self.serialport.read(self.count)
278 elif self.verb==0xFE:
279 print "# DEBUG 0x%x" % struct.unpack(fmt[self.count-1], self.serialport.read(self.count))[0]
280 elif self.verb==0xFD:
281 #Do nothing, just wait so there's no timeout.
286 self.data=self.serialport.read(self.count);
290 print "Warning: waiting for serial read timed out (most likely).";
291 #print "This shouldn't happen after syncing. Exiting for safety.";
295 def glitchApp(self,app):
296 """Glitch into a device by its application."""
297 self.data=[app&0xff];
298 self.writecmd(self.GLITCHAPP,0x80,1,self.data);
299 #return ord(self.data[0]);
300 def glitchVerb(self,app,verb,data):
301 """Glitch during a transaction."""
302 if data==None: data=[];
303 self.data=[app&0xff, verb&0xFF]+data;
304 self.writecmd(self.GLITCHAPP,0x81,len(self.data),self.data);
305 #return ord(self.data[0]);
306 def glitchstart(self):
307 """Glitch into the AVR application."""
308 self.glitchVerb(self.APP,0x20,None);
309 def glitchstarttime(self):
310 """Measure the timer of the START verb."""
311 return self.glitchTime(self.APP,0x20,None);
312 def glitchTime(self,app,verb,data):
313 """Time the execution of a verb."""
314 if data==None: data=[];
315 self.data=[app&0xff, verb&0xFF]+data;
316 print "Timing app %02x verb %02x." % (app,verb);
317 self.writecmd(self.GLITCHAPP,0x82,len(self.data),self.data);
318 time=ord(self.data[0])+(ord(self.data[1])<<8);
319 print "Timed to be %i." % time;
321 def glitchVoltages(self,low=0x0880, high=0x0fff):
322 """Set glitching voltages. (0x0fff is max.)"""
323 self.data=[low&0xff, (low>>8)&0xff,
324 high&0xff, (high>>8)&0xff];
325 self.writecmd(self.GLITCHAPP,0x90,4,self.data);
326 #return ord(self.data[0]);
327 def glitchRate(self,count=0x0800):
328 """Set glitching count period."""
329 self.data=[count&0xff, (count>>8)&0xff];
330 self.writecmd(self.GLITCHAPP,0x91,2,
332 #return ord(self.data[0]);
336 def silent(self,s=0):
337 """Transmissions halted when 1."""
339 print "besilent is %i" % self.besilent;
340 self.writecmd(0,0xB0,1,[s]);
342 def mon_connected(self):
343 """Announce to the monitor that the connection is good."""
345 self.writecmd(0,0xB1,0,[]);
347 """Write a byte to P5OUT."""
348 self.writecmd(0,0xA1,1,[byte]);
350 """Write a byte to P5DIR."""
351 self.writecmd(0,0xA0,1,[byte]);
353 """Call to an address."""
354 self.writecmd(0,0x30,2,
355 [adr&0xFF,(adr>>8)&0xFF]);
356 def execute(self,code):
357 """Execute supplied code."""
358 self.writecmd(0,0x31,2,#len(code),
360 def peekbyte(self,address):
361 """Read a byte of memory from the monitor."""
362 self.data=[address&0xff,address>>8];
363 self.writecmd(0,0x02,2,self.data);
365 return ord(self.data[0]);
366 def peekword(self,address):
367 """Read a word of memory from the monitor."""
368 return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
369 def peek(self,address):
370 """Read a word of memory from the monitor."""
371 return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
372 def eeprompeek(self,address):
373 """Read a word of memory from the monitor."""
374 return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
375 def peekbysym(self,name):
376 """Read a value by its symbol name."""
377 #TODO include memory in symbol.
378 reg=self.symbols.get(name);
379 return self.peek8(reg,"data");
380 def pokebysym(self,name,val):
381 """Write a value by its symbol name."""
382 #TODO include memory in symbol.
383 reg=self.symbols.get(name);
384 return self.pokebyte(reg,val);
385 def pokebyte(self,address,value,memory="vn"):
386 """Set a byte of memory by the monitor."""
387 self.data=[address&0xff,address>>8,value];
388 self.writecmd(0,0x03,3,self.data);
389 return ord(self.data[0]);
390 def poke16(self,address,value):
391 """Set a word of memory by the monitor."""
392 self.pokebyte(address,value&0xFF);
393 self.pokebyte(address,(value>>8)&0xFF);
395 def setsecret(self,value):
396 """Set a secret word for later retreival. Used by glitcher."""
397 self.eeprompoke(0,value);
398 self.eeprompoke(1,value);
400 """Get a secret word. Used by glitcher."""
403 def dumpmem(self,begin,end):
406 print "%04x %04x" % (i, self.peekword(i));
408 def monitor_ram_pattern(self):
409 """Overwrite all of RAM with 0xBEEF."""
410 self.writecmd(0,0x90,0,self.data);
412 def monitor_ram_depth(self):
413 """Determine how many bytes of RAM are unused by looking for 0xBEEF.."""
414 self.writecmd(0,0x91,0,self.data);
415 return ord(self.data[0])+(ord(self.data[1])<<8);
424 def setBaud(self,baud):
425 """Change the baud rate. TODO fix this."""
426 rates=self.baudrates;
428 print "Changing FET baud."
429 self.serialport.write(chr(0x00));
430 self.serialport.write(chr(0x80));
431 self.serialport.write(chr(1));
432 self.serialport.write(chr(baud));
434 print "Changed host baud."
435 self.serialport.setBaudrate(rates[baud]);
437 self.serialport.flushInput()
438 self.serialport.flushOutput()
440 print "Baud is now %i." % rates[baud];
443 return ord(self.serialport.read(1));
445 for r in self.baudrates:
446 print "\nTrying %i" % r;
447 self.serialport.setBaudrate(r);
449 self.serialport.flushInput()
450 self.serialport.flushOutput()
452 for i in range(1,10):
455 print "Read %02x %02x %02x %02x" % (
456 self.readbyte(),self.readbyte(),self.readbyte(),self.readbyte());
457 def monitortest(self):
458 """Self-test several functions through the monitor."""
459 print "Performing monitor self-test.";
460 self.monitorclocking();
461 for f in range(0,3000):
462 a=self.peekword(0x0c00);
463 b=self.peekword(0x0c02);
464 if a!=0x0c04 and a!=0x0c06:
465 print "ERROR Fetched %04x, %04x" % (a,b);
466 self.pokebyte(0x0021,0); #Drop LED
467 if self.peekbyte(0x0021)!=0:
468 print "ERROR, P1OUT not cleared.";
469 self.pokebyte(0x0021,1); #Light LED
470 if not self.monitorecho():
471 print "Echo test failed.";
472 print "Self-test complete.";
473 self.monitorclocking();
474 def monitorecho(self):
475 data="The quick brown fox jumped over the lazy dog.";
476 self.writecmd(self.MONITORAPP,0x81,len(data),data);
478 if self.verbose: print "Comm error recognized by monitorecho().";
481 def monitorclocking(self):
482 """Return the 16-bit clocking value."""
483 return "0x%04x" % self.monitorgetclock();
485 def monitorsetclock(self,clock):
486 """Set the clocking value."""
487 self.poke16(0x56, clock);
488 def monitorgetclock(self):
489 """Get the clocking value."""
490 return self.peek16(0x56);
491 # The following functions ought to be implemented in
494 def infostring(self):
495 a=self.peekbyte(0xff0);
496 b=self.peekbyte(0xff1);
497 return "%02x%02x" % (a,b);
499 print "Locking Unsupported.";
501 print "Erasure Unsupported.";
507 print "Unimplemented.";
510 print "Unimplemented.";
513 print "Unimplemented.";
516 print "Unimplemented.";
519 print "Unimplemented.";
521 def flash(self,file):
522 """Flash an intel hex file to code memory."""
523 print "Flash not implemented.";
524 def dump(self,file,start=0,stop=0xffff):
525 """Dump an intel hex file from code memory."""
526 print "Dump not implemented.";
527 def peek32(self,address, memory="vn"):
529 return (self.peek16(address,memory)+
530 (self.peek16(address+2,memory)<<16));
531 def peek16(self,address, memory="vn"):
532 """Peek 16 bits of memory."""
533 return (self.peek8(address,memory)+
534 (self.peek8(address+1,memory)<<8));
535 def peek8(self,address, memory="vn"):
536 """Peek a byte of memory."""
537 return self.peekbyte(address); #monitor
538 def peekword(self,address, memory="vn"):
539 """Peek a natively sized word of memory."""
540 return self.peek16(address); #monitor
541 def peekblock(self,address,length,memory="vn"):
542 """Return a block of data."""
543 data=range(0,length);
544 for foo in range(0,length):
545 data[foo]=self.peek8(address+foo,memory);
547 def pokeblock(self,address,bytes,memory="vn"):
548 """Poke a block of a data into memory at an address."""
550 self.pokebyte(address,foo,memory);
553 def loadsymbols(self):
554 """Load symbols from a file."""