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, attemptlimit=None):
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 glob_list = glob.glob("/dev/ttyU0");
95 if len(glob_list) > 0:
98 from scanwin32 import winScan;
100 for order,comport,desc,hwid in sorted(scan.comports()):
102 if hwid.index('FTDI')==0:
104 #print "Using FTDI port %s" % port
109 self.serialport = serial.Serial(
113 parity = serial.PARITY_NONE,
121 while self.verb!=0x7F or self.data!="http://goodfet.sf.net/":
122 if attemptlimit is not None and attempts >= attemptlimit:
126 self.serialport.flushInput()
127 self.serialport.flushOutput()
128 #Explicitly set RTS and DTR to halt board.
129 self.serialport.setRTS(1);
130 self.serialport.setDTR(1);
131 #Drop DTR, which is !RST, low to begin the app.
132 self.serialport.setDTR(0);
134 #TelosB reset, prefer software to I2C SPST Switch.
135 if(os.environ.get("platform")=='telosb'):
136 #print "TelosB Reset";
138 #self.serialport.write(chr(0x80));
139 #self.serialport.write(chr(0x80));
140 #self.serialport.write(chr(0x80));
141 #self.serialport.write(chr(0x80));
144 self.serialport.flushInput()
145 self.serialport.flushOutput()
148 self.readcmd(); #Read the first command.
149 #Here we have a connection, but maybe not a good one.
151 olds=self.infostring();
152 clocking=self.monitorclocking();
153 for foo in range(1,30):
154 if not self.monitorecho():
155 if self.verbose: print "Comm error on %i try, resyncing out of %s." % (foo,
159 if self.verbose: print "Connected after %02i attempts." % attempts;
160 self.mon_connected();
161 self.serialport.setTimeout(12);
163 self.serialport.close();
164 def telosSetSCL(self, level):
165 self.serialport.setRTS(not level)
166 def telosSetSDA(self, level):
167 self.serialport.setDTR(not level)
169 def telosI2CStart(self):
174 def telosI2CStop(self):
179 def telosI2CWriteBit(self, bit):
181 self.telosSetSDA(bit)
187 def telosI2CWriteByte(self, byte):
188 self.telosI2CWriteBit( byte & 0x80 );
189 self.telosI2CWriteBit( byte & 0x40 );
190 self.telosI2CWriteBit( byte & 0x20 );
191 self.telosI2CWriteBit( byte & 0x10 );
192 self.telosI2CWriteBit( byte & 0x08 );
193 self.telosI2CWriteBit( byte & 0x04 );
194 self.telosI2CWriteBit( byte & 0x02 );
195 self.telosI2CWriteBit( byte & 0x01 );
196 self.telosI2CWriteBit( 0 ); # "acknowledge"
198 def telosI2CWriteCmd(self, addr, cmdbyte):
200 self.telosI2CWriteByte( 0x90 | (addr << 1) )
201 self.telosI2CWriteByte( cmdbyte )
204 def telosBReset(self,invokeBSL=0):
205 # "BSL entry sequence at dedicated JTAG pins"
206 # rst !s0: 0 0 0 0 1 1
207 # tck !s1: 1 0 1 0 0 1
210 # "BSL entry sequence at shared JTAG pins"
211 # rst !s0: 0 0 0 0 1 1
212 # tck !s1: 0 1 0 1 1 0
216 self.telosI2CWriteCmd(0,1)
217 self.telosI2CWriteCmd(0,3)
218 self.telosI2CWriteCmd(0,1)
219 self.telosI2CWriteCmd(0,3)
220 self.telosI2CWriteCmd(0,2)
221 self.telosI2CWriteCmd(0,0)
223 self.telosI2CWriteCmd(0,3)
224 self.telosI2CWriteCmd(0,2)
226 # This line was not defined inside the else: block, not sure where it
228 self.telosI2CWriteCmd(0,0)
229 time.sleep(0.250) #give MSP430's oscillator time to stabilize
230 self.serialport.flushInput() #clear buffers
233 def getbuffer(self,size=0x1c00):
234 writecmd(0,0xC2,[size&0xFF,(size>>16)&0xFF]);
235 print "Got %02x%02x buffer size." % (self.data[1],self.data[0]);
236 def writecmd(self, app, verb, count=0, data=[]):
237 """Write a command and some data to the GoodFET."""
238 self.serialport.write(chr(app));
239 self.serialport.write(chr(verb));
242 # count=len(data); #Initial count ignored.
244 #print "TX %02x %02x %04x" % (app,verb,count);
246 #little endian 16-bit length
247 self.serialport.write(chr(count&0xFF));
248 self.serialport.write(chr(count>>8));
251 print "Tx: ( 0x%02x, 0x%02x, 0x%04x )" % ( app, verb, count )
253 #print "count=%02x, len(data)=%04x" % (count,len(data));
256 if(isinstance(data,list)):
257 for i in range(0,count):
258 #print "Converting %02x at %i" % (data[i],i)
259 data[i]=chr(data[i]);
261 outstr=''.join(data);
262 self.serialport.write(outstr);
263 if not self.besilent:
264 return self.readcmd()
269 """Read a reply from the GoodFET."""
270 while 1:#self.serialport.inWaiting(): # Loop while input data is available
273 self.app=ord(self.serialport.read(1));
274 #print "APP=%2x" % self.app;
275 self.verb=ord(self.serialport.read(1));
276 #print "VERB=%02x" % self.verb;
278 ord(self.serialport.read(1))
279 +(ord(self.serialport.read(1))<<8)
283 print "Rx: ( 0x%02x, 0x%02x, 0x%04x )" % ( self.app, self.verb, self.count )
285 #Debugging string; print, but wait.
288 print "# DEBUG %s" % self.serialport.read(self.count)
289 elif self.verb==0xFE:
290 print "# DEBUG 0x%x" % struct.unpack(fmt[self.count-1], self.serialport.read(self.count))[0]
291 elif self.verb==0xFD:
292 #Do nothing, just wait so there's no timeout.
297 self.data=self.serialport.read(self.count);
301 print "Warning: waiting for serial read timed out (most likely).";
302 #print "This shouldn't happen after syncing. Exiting for safety.";
306 def glitchApp(self,app):
307 """Glitch into a device by its application."""
308 self.data=[app&0xff];
309 self.writecmd(self.GLITCHAPP,0x80,1,self.data);
310 #return ord(self.data[0]);
311 def glitchVerb(self,app,verb,data):
312 """Glitch during a transaction."""
313 if data==None: data=[];
314 self.data=[app&0xff, verb&0xFF]+data;
315 self.writecmd(self.GLITCHAPP,0x81,len(self.data),self.data);
316 #return ord(self.data[0]);
317 def glitchstart(self):
318 """Glitch into the AVR application."""
319 self.glitchVerb(self.APP,0x20,None);
320 def glitchstarttime(self):
321 """Measure the timer of the START verb."""
322 return self.glitchTime(self.APP,0x20,None);
323 def glitchTime(self,app,verb,data):
324 """Time the execution of a verb."""
325 if data==None: data=[];
326 self.data=[app&0xff, verb&0xFF]+data;
327 print "Timing app %02x verb %02x." % (app,verb);
328 self.writecmd(self.GLITCHAPP,0x82,len(self.data),self.data);
329 time=ord(self.data[0])+(ord(self.data[1])<<8);
330 print "Timed to be %i." % time;
332 def glitchVoltages(self,low=0x0880, high=0x0fff):
333 """Set glitching voltages. (0x0fff is max.)"""
334 self.data=[low&0xff, (low>>8)&0xff,
335 high&0xff, (high>>8)&0xff];
336 self.writecmd(self.GLITCHAPP,0x90,4,self.data);
337 #return ord(self.data[0]);
338 def glitchRate(self,count=0x0800):
339 """Set glitching count period."""
340 self.data=[count&0xff, (count>>8)&0xff];
341 self.writecmd(self.GLITCHAPP,0x91,2,
343 #return ord(self.data[0]);
347 def silent(self,s=0):
348 """Transmissions halted when 1."""
350 print "besilent is %i" % self.besilent;
351 self.writecmd(0,0xB0,1,[s]);
353 def mon_connected(self):
354 """Announce to the monitor that the connection is good."""
356 self.writecmd(0,0xB1,0,[]);
358 """Write a byte to P5OUT."""
359 self.writecmd(0,0xA1,1,[byte]);
361 """Write a byte to P5DIR."""
362 self.writecmd(0,0xA0,1,[byte]);
364 """Call to an address."""
365 self.writecmd(0,0x30,2,
366 [adr&0xFF,(adr>>8)&0xFF]);
367 def execute(self,code):
368 """Execute supplied code."""
369 self.writecmd(0,0x31,2,#len(code),
371 def MONpeek8(self,address):
372 """Read a byte of memory from the monitor."""
373 self.data=[address&0xff,address>>8];
374 self.writecmd(0,0x02,2,self.data);
376 return ord(self.data[0]);
377 def MONpeek16(self,address):
378 """Read a word of memory from the monitor."""
379 return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
380 def peek(self,address):
381 """Read a word of memory from the monitor."""
382 return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
383 def eeprompeek(self,address):
384 """Read a word of memory from the monitor."""
385 print "EEPROM peeking not supported for the monitor.";
386 #return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
387 def peekbysym(self,name):
388 """Read a value by its symbol name."""
389 #TODO include memory in symbol.
390 reg=self.symbols.get(name);
391 return self.peek8(reg,"data");
392 def pokebysym(self,name,val):
393 """Write a value by its symbol name."""
394 #TODO include memory in symbol.
395 reg=self.symbols.get(name);
396 return self.pokebyte(reg,val);
397 def pokebyte(self,address,value,memory="vn"):
398 """Set a byte of memory by the monitor."""
399 self.data=[address&0xff,address>>8,value];
400 self.writecmd(0,0x03,3,self.data);
401 return ord(self.data[0]);
402 def poke16(self,address,value):
403 """Set a word of memory by the monitor."""
404 self.pokebyte(address,value&0xFF);
405 self.pokebyte(address,(value>>8)&0xFF);
407 def setsecret(self,value):
408 """Set a secret word for later retreival. Used by glitcher."""
409 #self.eeprompoke(0,value);
410 #self.eeprompoke(1,value);
411 print "Secret setting is not yet suppored for this target.";
415 """Get a secret word. Used by glitcher."""
417 print "Secret setting is not yet suppored for this target.";
421 def dumpmem(self,begin,end):
424 print "%04x %04x" % (i, self.MONpeek16(i));
426 def monitor_ram_pattern(self):
427 """Overwrite all of RAM with 0xBEEF."""
428 self.writecmd(0,0x90,0,self.data);
430 def monitor_ram_depth(self):
431 """Determine how many bytes of RAM are unused by looking for 0xBEEF.."""
432 self.writecmd(0,0x91,0,self.data);
433 return ord(self.data[0])+(ord(self.data[1])<<8);
442 def setBaud(self,baud):
443 """Change the baud rate. TODO fix this."""
444 rates=self.baudrates;
446 print "Changing FET baud."
447 self.serialport.write(chr(0x00));
448 self.serialport.write(chr(0x80));
449 self.serialport.write(chr(1));
450 self.serialport.write(chr(baud));
452 print "Changed host baud."
453 self.serialport.setBaudrate(rates[baud]);
455 self.serialport.flushInput()
456 self.serialport.flushOutput()
458 print "Baud is now %i." % rates[baud];
461 return ord(self.serialport.read(1));
463 for r in self.baudrates:
464 print "\nTrying %i" % r;
465 self.serialport.setBaudrate(r);
467 self.serialport.flushInput()
468 self.serialport.flushOutput()
470 for i in range(1,10):
473 print "Read %02x %02x %02x %02x" % (
474 self.readbyte(),self.readbyte(),self.readbyte(),self.readbyte());
475 def monitortest(self):
476 """Self-test several functions through the monitor."""
477 print "Performing monitor self-test.";
478 self.monitorclocking();
479 for f in range(0,3000):
480 a=self.MONpeek16(0x0c00);
481 b=self.MONpeek16(0x0c02);
482 if a!=0x0c04 and a!=0x0c06:
483 print "ERROR Fetched %04x, %04x" % (a,b);
484 self.pokebyte(0x0021,0); #Drop LED
485 if self.MONpeek8(0x0021)!=0:
486 print "ERROR, P1OUT not cleared.";
487 self.pokebyte(0x0021,1); #Light LED
488 if not self.monitorecho():
489 print "Echo test failed.";
490 print "Self-test complete.";
491 self.monitorclocking();
492 def monitorecho(self):
493 data="The quick brown fox jumped over the lazy dog.";
494 self.writecmd(self.MONITORAPP,0x81,len(data),data);
496 if self.verbose: print "Comm error recognized by monitorecho().";
500 def monitor_info(self):
501 print "GoodFET with %s MCU" % self.infostring();
502 print "Clocked at %s" % self.monitorclocking();
505 def monitor_list_apps(self, full=False):
507 old_value = self.besilent
508 self.besilent = True # turn off automatic call to readcmd
509 self.writecmd(self.MONITORAPP, 0x82, 1, [int(full)]);
510 self.besilent = old_value
512 # read the build date string
514 print "Build Date: %s" % self.data
515 print "Firmware apps:"
523 def monitorclocking(self):
524 """Return the 16-bit clocking value."""
525 return "0x%04x" % self.monitorgetclock();
527 def monitorsetclock(self,clock):
528 """Set the clocking value."""
529 self.MONpoke16(0x56, clock);
530 def monitorgetclock(self):
531 """Get the clocking value."""
532 return self.MONpeek16(0x56);
533 # The following functions ought to be implemented in
536 def infostring(self):
537 a=self.MONpeek8(0xff0);
538 b=self.MONpeek8(0xff1);
539 return "%02x%02x" % (a,b);
541 print "Locking Unsupported.";
543 print "Erasure Unsupported.";
549 print "Unimplemented.";
552 print "Unimplemented.";
555 print "Unimplemented.";
558 print "Unimplemented.";
561 print "Unimplemented.";
563 def flash(self,file):
564 """Flash an intel hex file to code memory."""
565 print "Flash not implemented.";
566 def dump(self,file,start=0,stop=0xffff):
567 """Dump an intel hex file from code memory."""
568 print "Dump not implemented.";
569 def peek32(self,address, memory="vn"):
571 return (self.peek16(address,memory)+
572 (self.peek16(address+2,memory)<<16));
573 def peek16(self,address, memory="vn"):
574 """Peek 16 bits of memory."""
575 return (self.peek8(address,memory)+
576 (self.peek8(address+1,memory)<<8));
577 def peek8(self,address, memory="vn"):
578 """Peek a byte of memory."""
579 return self.MONpeek8(address); #monitor
580 def peekblock(self,address,length,memory="vn"):
581 """Return a block of data."""
582 data=range(0,length);
583 for foo in range(0,length):
584 data[foo]=self.peek8(address+foo,memory);
586 def pokeblock(self,address,bytes,memory="vn"):
587 """Poke a block of a data into memory at an address."""
589 self.pokebyte(address,foo,memory);
592 def loadsymbols(self):
593 """Load symbols from a file."""