#
# (C) 2009 Travis Goodspeed <travis at radiantmachines.com>
#
-# This code is ugly as sin, for bootstrapping the firmware only.
-# Rewrite cleanly as soon as is convenient.
+# This code is being rewritten and refactored. You've been warned!
-import sys, time, string, cStringIO, struct
-sys.path.append("/usr/lib/tinyos")
-import serial
+import sys, time, string, cStringIO, struct, glob, serial, os;
class GoodFET:
+ """GoodFET Client Library"""
def __init__(self, *args, **kargs):
self.data=[0];
def timeout(self):
- print "timout\n";
- def serInit(self, port):
+ print "timeout\n";
+ def serInit(self, port=None):
"""Open the serial port"""
+
+ if port is None and os.environ.get("GOODFET")!=None:
+ glob_list = glob.glob(os.environ.get("GOODFET"));
+ if len(glob_list) > 0:
+ port = glob_list[0];
+ if port is None:
+ glob_list = glob.glob("/dev/tty.usbserial*");
+ if len(glob_list) > 0:
+ port = glob_list[0];
+ if port is None:
+ glob_list = glob.glob("/dev/ttyUSB*");
+ if len(glob_list) > 0:
+ port = glob_list[0];
+
self.serialport = serial.Serial(
port,
#9600,
#time.sleep(1);
self.readcmd(); #Read the first command.
if(self.verb!=0x7F):
- print "Verb is wrong. Incorrect firmware?";
-
- def writecmd(self, app, verb, count, data):
+ print "Verb %02x is wrong. Incorrect firmware?" % self.verb;
+ #print "Connected."
+ def getbuffer(self,size=0x1c00):
+ writecmd(0,0xC2,[size&0xFF,(size>>16)&0xFF]);
+ print "Got %02x%02x buffer size." % (self.data[1],self.data[0]);
+ def writecmd(self, app, verb, count=0, data=[]):
"""Write a command and some data to the GoodFET."""
self.serialport.write(chr(app));
self.serialport.write(chr(verb));
- self.serialport.write(chr(count));
+
+
+ #print "TX %02x %02x" % (app,verb);
+
+ #little endian 16-bit length
+ self.serialport.write(chr(count&0xFF));
+ self.serialport.write(chr(count>>8));
+
#print "count=%02x, len(data)=%04x" % (count,len(data));
+
if count!=0:
- for d in data:
- self.serialport.write(chr(d));
- self.readcmd(); #Uncomment this later, to ensure a response.
+ for i in range(0,count):
+ #print "Converting %02x at %i" % (data[i],i)
+ data[i]=chr(data[i]);
+ outstr=''.join(data);
+ self.serialport.write(outstr);
+ if not self.besilent:
+ self.readcmd();
+
+ besilent=0;
+ app=0;
+ verb=0;
+ count=0;
+ data="";
+
def readcmd(self):
"""Read a reply from the GoodFET."""
- self.app=ord(self.serialport.read(1));
- self.verb=ord(self.serialport.read(1));
- self.count=ord(self.serialport.read(1));
- if self.count>0:
- self.data=self.serialport.read(self.count);
- #print "READ %02x %02x %02x " % (self.app, self.verb, self.count);
-
+ while 1:
+ #print "Reading...";
+ self.app=ord(self.serialport.read(1));
+ #print "APP=%2x" % self.app;
+ self.verb=ord(self.serialport.read(1));
+ #print "VERB=%02x" % self.verb;
+ self.count=(
+ ord(self.serialport.read(1))
+ +(ord(self.serialport.read(1))<<8)
+ );
+
+ #Debugging string; print, but wait.
+ if self.app==0xFF and self.verb==0xFF:
+ print "DEBUG %s" % self.serialport.read(self.count);
+ else:
+ self.data=self.serialport.read(self.count);
+ return self.data;
+
#Monitor stuff
+ def silent(self,s=0):
+ """Transmissions halted when 1."""
+ self.besilent=s;
+ print "besilent is %i" % self.besilent;
+ self.writecmd(0,0xB0,1,[s]);
+
+ def out(self,byte):
+ """Write a byte to P5OUT."""
+ self.writecmd(0,0xA1,1,[byte]);
+ def dir(self,byte):
+ """Write a byte to P5DIR."""
+ self.writecmd(0,0xA0,1,[byte]);
def peekbyte(self,address):
"""Read a byte of memory from the monitor."""
self.data=[address&0xff,address>>8];
self.data=[address&0xff,address>>8,value];
self.writecmd(0,0x03,3,self.data);
return ord(self.data[0]);
+ def dumpmem(self,begin,end):
+ i=begin;
+ while i<end:
+ print "%04x %04x" % (i, self.peekword(i));
+ i+=2;
+ def monitor_ram_pattern(self):
+ """Overwrite all of RAM with 0xBEEF."""
+ self.writecmd(0,0x90,0,self.data);
+ return;
+ def monitor_ram_depth(self):
+ """Determine how many bytes of RAM are unused by looking for 0xBEEF.."""
+ self.writecmd(0,0x91,0,self.data);
+ return ord(self.data[0])+(ord(self.data[1])<<8);
+
+ #Baud rates.
+ baudrates=[115200,
+ 9600,
+ 19200,
+ 38400,
+ 57600,
+ 115200];
def setBaud(self,baud):
- rates=[9600, 9600, 19200, 38400];
+ """Change the baud rate. TODO fix this."""
+ rates=self.baudrates;
self.data=[baud];
print "Changing FET baud."
self.serialport.write(chr(0x00));
print "Baud is now %i." % rates[baud];
return;
+ def readbyte(self):
+ return ord(self.serialport.read(1));
+ def findbaud(self):
+ for r in self.baudrates:
+ print "\nTrying %i" % r;
+ self.serialport.setBaudrate(r);
+ #time.sleep(1);
+ self.serialport.flushInput()
+ self.serialport.flushOutput()
+
+ for i in range(1,10):
+ self.readbyte();
+
+ print "Read %02x %02x %02x %02x" % (
+ self.readbyte(),self.readbyte(),self.readbyte(),self.readbyte());
def monitortest(self):
"""Self-test several functions through the monitor."""
print "Performing monitor self-test.";
- if self.peekword(0x0c00)!=0x0c04:
+ if self.peekword(0x0c00)!=0x0c04 and self.peekword(0x0c00)!=0x0c06:
print "ERROR Fetched wrong value from 0x0c04.";
self.pokebyte(0x0021,0); #Drop LED
if self.peekbyte(0x0021)!=0:
print "Self-test complete.";
- def spisetup(self):
- """Moved the FET into the SPI application."""
- self.writecmd(1,0x10,0,self.data); #SPI/SETUP
- #self.readcmd();
- def spitrans8(self,byte):
- """Read and write 8 bits by SPI."""
- self.data=[byte];
- self.writecmd(1,0,1,self.data); #SPI exchange
- #self.readcmd();
-
- if self.app!=1 or self.verb!=0:
- print "Error in SPI transaction; app=%02x, verb=%02x" % (self.app, self.verb);
+
+
+ def I2Csetup(self):
+ """Move the FET into the I2C application."""
+ self.writecmd(0x02,0x10,0,self.data); #SPI/SETUP
+ def I2Cstart(self):
+ """Start an I2C transaction."""
+ self.writecmd(0x02,0x20,0,self.data); #SPI/SETUP
+ def I2Cstop(self):
+ """Stop an I2C transaction."""
+ self.writecmd(0x02,0x21,0,self.data); #SPI/SETUP
+ def I2Cread(self,len=1):
+ """Read len bytes by I2C."""
+ self.writecmd(0x02,0x00,1,[len]); #SPI/SETUP
+ return self.data;
+ def I2Cwrite(self,bytes):
+ """Write bytes by I2C."""
+ self.writecmd(0x02,0x01,len(bytes),bytes); #SPI/SETUP
return ord(self.data[0]);
- def MSP430setup(self):
- """Move the FET into the MSP430 JTAG application."""
- print "Initializing MSP430.";
- self.writecmd(0x11,0x10,0,self.data);
+class GoodFETCC(GoodFET):
+ """A GoodFET variant for use with Chipcon 8051 Zigbe SoC."""
+ def CChaltcpu(self):
+ """Halt the CPU."""
+ self.writecmd(0x30,0x86,0,self.data);
+ def CCreleasecpu(self):
+ """Resume the CPU."""
+ self.writecmd(0x30,0x87,0,self.data);
+ def CCtest(self):
+ self.CCreleasecpu();
+ self.CChaltcpu();
+ #print "Status: %s" % self.CCstatusstr();
+
+ #Grab ident three times, should be equal.
+ ident1=self.CCident();
+ ident2=self.CCident();
+ ident3=self.CCident();
+ if(ident1!=ident2 or ident2!=ident3):
+ print "Error, repeated ident attempts unequal."
+ print "%04x, %04x, %04x" % (ident1, ident2, ident3);
+
+ #Single step, printing PC.
+ print "Tracing execution at startup."
+ for i in range(1,15):
+ pc=self.CCgetPC();
+ byte=self.CCpeekcodebyte(i);
+ #print "PC=%04x, %02x" % (pc, byte);
+ self.CCstep_instr();
+
+ print "Verifying that debugging a NOP doesn't affect the PC."
+ for i in range(1,15):
+ pc=self.CCgetPC();
+ self.CCdebuginstr([0x00]);
+ if(pc!=self.CCgetPC()):
+ print "ERROR: PC changed during CCdebuginstr([NOP])!";
+
+
+ #print "Status: %s." % self.CCstatusstr();
+ #Exit debugger
+ self.CCstop();
+ print "Done.";
+
def CCsetup(self):
"""Move the FET into the CC2430/CC2530 application."""
- print "Initializing Chipcon.";
+ #print "Initializing Chipcon.";
self.writecmd(0x30,0x10,0,self.data);
def CCrd_config(self):
"""Read the config register of a Chipcon."""
0xFF00:"CCmissing"};
def CCidentstr(self):
ident=self.CCident();
- chip=self.CCversions[ident&0xFF00];
+ chip=self.CCversions.get(ident&0xFF00);
return "%s/r%02x" % (chip, ident&0xFF);
def CCident(self):
"""Get a chipcon's ID."""
def CCdebuginstr(self,instr):
self.writecmd(0x30,0x88,len(instr),instr);
return ord(self.data[0]);
- def MSP430peek(self,adr):
- """Read the contents of memory at an address."""
- self.data=[adr&0xff, (adr&0xff00)>>8];
- self.writecmd(0x11,0x02,2,self.data);
- return ord(self.data[0])+(ord(self.data[1])<<8);
def CCpeekcodebyte(self,adr):
"""Read the contents of code memory at an address."""
self.data=[adr&0xff, (adr&0xff00)>>8];
str="%s %s" %(self.CCstatusbits[i],str);
i*=2;
return str;
- def MSP430poke(self,adr,val):
- """Read the contents of memory at an address."""
- self.data=[adr&0xff, (adr&0xff00)>>8, val&0xff, (val&0xff00)>>8];
- self.writecmd(0x11,0x03,4,self.data);
- return;# ord(self.data[0])+(ord(self.data[1])<<8);
- def MSP430start(self):
- """Start debugging."""
- self.writecmd(0x11,0x20,0,self.data);
- ident=self.MSP430ident();
- print "Target identifies as %04x." % ident;
-
def CCstart(self):
"""Start debugging."""
self.writecmd(0x30,0x20,0,self.data);
ident=self.CCidentstr();
print "Target identifies as %s." % ident;
- print "Status: %s." % self.CCstatusstr();
+ #print "Status: %s." % self.CCstatusstr();
self.CCreleasecpu();
self.CChaltcpu();
- print "Status: %s." % self.CCstatusstr();
+ #print "Status: %s." % self.CCstatusstr();
+
def CCstop(self):
"""Stop debugging."""
self.writecmd(0x30,0x21,0,self.data);
def CCstep_instr(self):
"""Step one instruction."""
self.writecmd(0x30,0x89,0,self.data);
- def MSP430stop(self):
- """Stop debugging."""
- self.writecmd(0x11,0x21,0,self.data);
- def MSP430haltcpu(self):
- """Halt the CPU."""
- self.writecmd(0x11,0xA0,0,self.data);
- def MSP430releasecpu(self):
- """Resume the CPU."""
- self.writecmd(0x11,0xA1,0,self.data);
- def CChaltcpu(self):
- """Halt the CPU."""
- self.writecmd(0x30,0x86,0,self.data);
- def CCreleasecpu(self):
- """Resume the CPU."""
- self.writecmd(0x30,0x87,0,self.data);
- def MSP430shiftir8(self,ins):
- """Shift the 8-bit Instruction Register."""
- data=[ins];
- self.writecmd(0x11,0x80,1,data);
- return ord(self.data[0]);
- def MSP430shiftdr16(self,dat):
- """Shift the 16-bit Data Register."""
- data=[dat&0xFF,(dat&0xFF00)>>8];
- self.writecmd(0x11,0x81,2,data);
- return ord(self.data[0])#+(ord(self.data[1])<<8);
- def MSP430setinstrfetch(self):
- """Set the instruction fetch mode."""
- self.writecmd(0x11,0xC1,0,self.data);
- return self.data[0];
- def MSP430ident(self):
- """Grab self-identification word from 0x0FF0 as big endian."""
- i=self.MSP430peek(0x0ff0);
- return ((i&0xFF00)>>8)+((i&0xFF)<<8)
- def MSP430test(self):
- """Test MSP430 JTAG. Requires that a chip be attached."""
- if self.MSP430ident()==0xffff:
- print "Is anything connected?";
- print "Testing RAM.";
- temp=self.MSP430peek(0x0200);
- self.MSP430poke(0x0200,0xdead);
- if(self.MSP430peek(0x0200)!=0xdead):
- print "Poke of 0x0200 did not set to 0xDEAD properly.";
- return;
- self.MSP430poke(0x0200,temp); #restore old value.
- def MSP430flashtest(self):
- self.MSP430masserase();
- i=0x2500;
- while(i<0xFFFF):
- if(self.MSP430peek(i)!=0xFFFF):
- print "ERROR: Unerased flash at %04x."%i;
- self.MSP430writeflash(i,0xDEAD);
- i+=2;
- def MSP430masserase(self):
- """Erase MSP430 flash memory."""
- self.writecmd(0x11,0xE3,0,None);
- def MSP430writeflash(self,adr,val):
- """Write a word of flash memory."""
- if(self.MSP430peek(adr)!=0xFFFF):
- print "FLASH ERROR: %04x not clear." % adr;
- data=[adr&0xFF,(adr&0xFF00)>>8,val&0xFF,(val&0xFF00)>>8];
- self.writecmd(0x11,0xE1,4,data);
- rval=ord(self.data[0])+(ord(self.data[1])<<8);
- if(val!=rval):
- print "FLASH WRITE ERROR AT %04x. Found %04x, wrote %04x." % (adr,rval,val);
-
- def MSP430dumpbsl(self):
- self.MSP430dumpmem(0xC00,0xfff);
- def MSP430dumpallmem(self):
- self.MSP430dumpmem(0x200,0xffff);
- def MSP430dumpmem(self,begin,end):
- i=begin;
- while i<end:
- print "%04x %04x" % (i, self.MSP430peek(i));
- i+=2;
- def CCtest(self):
- self.CCreleasecpu();
- self.CChaltcpu();
- print "Status: %s" % self.CCstatusstr();
-
- #Grab ident three times, should be equal.
- ident1=self.CCident();
- ident2=self.CCident();
- ident3=self.CCident();
- if(ident1!=ident2 or ident2!=ident3):
- print "Error, repeated ident attempts unequal."
- print "%04x, %04x, %04x" % (ident1, ident2, ident3);
-
- #Single step, printing PC.
- #print "Tracing execution at startup."
- for i in range(1,15):
- pc=self.CCgetPC();
- byte=self.CCpeekcodebyte(i);
- print "PC=%04x, %02x" % (pc, byte);
- self.CCstep_instr();
-
- #print "Verifying that debugging a NOP doesn't affect the PC."
- for i in range(1,15):
- pc=self.CCgetPC();
- self.CCdebuginstr([0x00]);
- if(pc!=self.CCgetPC()):
- print "ERROR: PC changed during CCdebuginstr([NOP])!";
- for i in range(0xE500,0xE600):
- byte=self.CCpeekdatabyte(i);
- print "data %04x: %02x" % (i,byte);
- self.CCpokedatabyte(i,i&0xFF);
- byte=self.CCpeekdatabyte(i);
- print "data %04x: %02x" % (i,byte);
- print "Status: %s." % self.CCstatusstr();
- #Exit debugger
- self.CCstop();
- print "Done.";
+