#
# (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, glob, serial, os;
+import sqlite3;
+def getClient(name="GoodFET"):
+ import GoodFET, GoodFETCC, GoodFETAVR, GoodFETSPI, GoodFETMSP430;
+ if(name=="GoodFET" or name=="monitor"): return GoodFET.GoodFET();
+ elif name=="cc" or name=="chipcon": return GoodFETCC.GoodFETCC();
+ elif name=="avr": return GoodFETAVR.GoodFETAVR();
+ elif name=="spi": return GoodFETSPI.GoodFETSPI();
+ elif name=="msp430": return GoodFETSPI.GoodFETMSP430();
+
+ print "Unsupported target: %s" % name;
+ sys.exit(0);
+
+class SymbolTable:
+ """GoodFET Symbol Table"""
+ db=sqlite3.connect(":memory:");
+
+ def __init__(self, *args, **kargs):
+ self.db.execute("create table if not exists symbols(adr,name,memory,size,comment);");
+ def get(self,name):
+ self.db.commit();
+ c=self.db.cursor();
+ try:
+ c.execute("select adr,memory from symbols where name=?",(name,));
+ for row in c:
+ #print "Found it.";
+ sys.stdout.flush();
+ return row[0];
+ #print "No dice.";
+ except:# sqlite3.OperationalError:
+ #print "SQL error.";
+ return eval(name);
+ return eval(name);
+ def define(self,adr,name,comment="",memory="vn",size=16):
+ self.db.execute("insert into symbols(adr,name,memory,size,comment)"
+ "values(?,?,?,?,?);", (
+ adr,name,memory,size,comment));
+ #print "Set %s=%s." % (name,adr);
class GoodFET:
+ """GoodFET Client Library"""
+
+ GLITCHAPP=0x71;
+ symbols=SymbolTable();
+
def __init__(self, *args, **kargs):
self.data=[0];
+ def getConsole(self):
+ from GoodFETConsole import GoodFETConsole;
+ return GoodFETConsole(self);
+ def name2adr(self,name):
+ return self.symbols.get(name);
def timeout(self):
print "timeout\n";
def serInit(self, port=None):
"""Open the serial port"""
- if port is None:
+ 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];
115200,
parity = serial.PARITY_NONE
)
+
+ #This might cause problems, but it makes failure graceful.
+ #self.serialport._timeout = 5;
+
+ #Explicitly set RTS and DTR to halt board.
+ self.serialport.setRTS(1);
+ self.serialport.setDTR(1);
#Drop DTR, which is !RST, low to begin the app.
self.serialport.setDTR(0);
self.serialport.flushInput()
if(self.verb!=0x7F):
print "Verb %02x is wrong. Incorrect firmware?" % self.verb;
#print "Connected."
- def writecmd(self, app, verb, count, data=[], blocks=1):
+ 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));
+
+ #if data!=None:
+ # count=len(data); #Initial count ignored.
+
+ #print "TX %02x %02x %04x" % (app,verb,count);
+
+ #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));
+ if(isinstance(data,list)):
+ for i in range(0,count):
+ #print "Converting %02x at %i" % (data[i],i)
+ data[i]=chr(data[i]);
+ #print type(data);
+ outstr=''.join(data);
+ self.serialport.write(outstr);
+ if not self.besilent:
+ self.readcmd();
- self.readcmd(blocks); #Uncomment this later, to ensure a response.
- def readcmd(self,blocks=1):
+ 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));
- self.data=self.serialport.read(self.count*blocks);
- return self.data;
- #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);
+ sys.stdout.flush();
+ else:
+ self.data=self.serialport.read(self.count);
+ return self.data;
+ #Glitching stuff.
+ def glitchApp(self,app):
+ """Glitch into a device by its application."""
+ self.data=[app&0xff];
+ self.writecmd(self.GLITCHAPP,0x80,1,self.data);
+ #return ord(self.data[0]);
+ def glitchVerb(self,app,verb,data):
+ """Glitch during a transaction."""
+ if data==None: data=[];
+ self.data=[app&0xff, verb&0xFF]+data;
+ self.writecmd(self.GLITCHAPP,0x81,len(self.data),self.data);
+ #return ord(self.data[0]);
+ def glitchstart(self):
+ """Glitch into the AVR application."""
+ self.glitchVerb(self.APP,0x20,None);
+ def glitchstarttime(self):
+ """Measure the timer of the START verb."""
+ return self.glitchTime(self.APP,0x20,None);
+ def glitchTime(self,app,verb,data):
+ """Time the execution of a verb."""
+ if data==None: data=[];
+ self.data=[app&0xff, verb&0xFF]+data;
+ self.writecmd(self.GLITCHAPP,0x82,len(self.data),self.data);
+ return ord(self.data[0])+(ord(self.data[1])<<8);
+ def glitchVoltages(self,low=0x0880, high=0x0fff):
+ """Set glitching voltages. (0x0fff is max.)"""
+ self.data=[low&0xff, (low>>8)&0xff,
+ high&0xff, (high>>8)&0xff];
+ self.writecmd(self.GLITCHAPP,0x90,4,self.data);
+ #return ord(self.data[0]);
+ def glitchRate(self,count=0x0800):
+ """Set glitching count period."""
+ self.data=[count&0xff, (count>>8)&0xff];
+ self.writecmd(self.GLITCHAPP,0x91,2,
+ self.data);
+ #return ord(self.data[0]);
+
+
#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 call(self,adr):
+ """Call to an address."""
+ self.writecmd(0,0x30,2,
+ [adr&0xFF,(adr>>8)&0xFF]);
+ def execute(self,code):
+ """Execute supplied code."""
+ self.writecmd(0,0x31,2,#len(code),
+ code);
def peekbyte(self,address):
"""Read a byte of memory from the monitor."""
self.data=[address&0xff,address>>8];
print "Self-test complete.";
- def SPIsetup(self):
- """Moved the FET into the SPI application."""
- self.writecmd(0x01,0x10,0,self.data); #SPI/SETUP
-
-
- def SPItrans8(self,byte):
- """Read and write 8 bits by SPI."""
- data=self.SPItrans([byte]);
- return ord(data[0]);
-
- def SPItrans(self,data):
- """Exchange data by SPI."""
- self.data=data;
- self.writecmd(0x01,0x00,len(data),data);
- return self.data;
- JEDECmanufacturers={0xFF: "MISSING",
- 0xEF: "Winbond",
- 0xC2: "MXIC",
- 0x20: "Numonyx/ST"
- };
+ # The following functions ought to be implemented in
+ # every client.
- JEDECdevices={0xFFFFFF: "MISSING",
- 0xEF3014: "W25X80L",
- 0xEF3013: "W25X40L",
- 0xEF3012: "W25X20L",
- 0xEF3011: "W25X10L",
- 0xC22014: "MX25L8005",
- 0xC22013: "MX25L4005",
- 0x204011: "M45PE10"
- };
- JEDECsizes={0x14: 0x100000,
- 0x13: 0x080000,
- 0x12: 0x040000,
- 0x11: 0x020000}
- JEDECsize=0;
- def SPIjedec(self):
- """Grab an SPI Flash ROM's JEDEC bytes."""
- data=[0x9f, 0, 0, 0];
- data=self.SPItrans(data);
- #print "Manufacturer: %02x\nType: %02x\nCapacity: %02x" % (ord(data[1]),ord(data[2]),ord(data[3]));
- self.JEDECmanufacturer=ord(data[1]);
- self.JEDECtype=ord(data[2]);
- self.JEDECcapacity=ord(data[3]);
- self.JEDECsize=self.JEDECsizes.get(self.JEDECcapacity);
- if self.JEDECsize==None:
- self.JEDECsize=0;
- self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
- return data;
- def SPIpeek(self,adr):
- """Grab a byte from an SPI Flash ROM."""
- data=[0x03,
- (adr&0xFF0000)>>16,
- (adr&0xFF00)>>8,
- adr&0xFF,
- 0];
- self.SPItrans(data);
- return ord(self.data[4]);
-# def SPIpeekblock(self,adr):
-# """Grab a block from an SPI Flash ROM. Block size is unknown"""
-# data=[(adr&0xFF0000)>>16,
-# (adr&0xFF00)>>8,
-# adr&0xFF];
-
-# self.writecmd(0x01,0x02,3,data);
-# return self.data;
- def SPIpeekblock(self,adr,blocks=1):
- """Grab a few block from an SPI Flash ROM. Block size is unknown"""
- data=[(adr&0xFF0000)>>16,
- (adr&0xFF00)>>8,
- adr&0xFF,
- blocks];
-
- self.writecmd(0x01,0x02,4,data,blocks);
- return self.data;
-
- def SPIpokebyte(self,adr,val):
- self.SPIpokebytes(adr,[val]);
- def SPIpokebytes(self,adr,data):
- #self.SPIwriteenable();
- adranddata=[(adr&0xFF0000)>>16,
- (adr&0xFF00)>>8,
- adr&0xFF
- ]+data;
- self.writecmd(0x01,0x03,
- len(adranddata),adranddata);
-
- def SPIchiperase(self):
- """Mass erase an SPI Flash ROM."""
- self.writecmd(0x01,0x81,0,[]);
- def SPIwriteenable(self):
- """SPI Flash Write Enable"""
- data=[0x06];
- self.SPItrans(data);
-
- def SPIjedecmanstr(self):
- """Grab the JEDEC manufacturer string. Call after SPIjedec()."""
- man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
- if man==0:
- man="UNKNOWN";
- return man;
-
- def SPIjedecstr(self):
- """Grab the JEDEC manufacturer string. Call after SPIjedec()."""
- man=self.JEDECmanufacturers.get(self.JEDECmanufacturer);
- if man==0:
- man="UNKNOWN";
- device=self.JEDECdevices.get(self.JEDECdevice);
- if device==0:
- device="???"
- return "%s %s" % (man,device);
- def MSP430setup(self):
- """Move the FET into the MSP430 JTAG application."""
- print "Initializing MSP430.";
- self.writecmd(0x11,0x10,0,self.data);
+ def infostring(self):
+ a=self.peekbyte(0xff0);
+ b=self.peekbyte(0xff1);
+ return "%02x%02x" % (a,b);
+ def lock(self):
+ print "Locking Unsupported.";
+ def erase(self):
+ print "Erasure Unsupported.";
+ def setup(self):
+ return;
+ def start(self):
+ return;
+ def test(self):
+ print "Unimplemented.";
+ return;
+ def status(self):
+ print "Unimplemented.";
+ return;
+ def halt(self):
+ print "Unimplemented.";
+ return;
+ def resume(self):
+ print "Unimplemented.";
+ return;
+ def getpc(self):
+ print "Unimplemented.";
+ return 0xdead;
+ def flash(self,file):
+ """Flash an intel hex file to code memory."""
+ print "Flash not implemented.";
+ def dump(self,file,start=0,stop=0xffff):
+ """Dump an intel hex file from code memory."""
+ print "Dump not implemented.";
- 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 CCsetup(self):
- """Move the FET into the CC2430/CC2530 application."""
- #print "Initializing Chipcon.";
- self.writecmd(0x30,0x10,0,self.data);
- def CCrd_config(self):
- """Read the config register of a Chipcon."""
- self.writecmd(0x30,0x82,0,self.data);
- return ord(self.data[0]);
- def CCwr_config(self,config):
- """Write the config register of a Chipcon."""
- self.writecmd(0x30,0x81,1,[config&0xFF]);
-
- CCversions={0x0100:"CC1110",
- 0x8500:"CC2430",
- 0x8900:"CC2431",
- 0x8100:"CC2510",
- 0x9100:"CC2511",
- 0xFF00:"CCmissing"};
- def CCidentstr(self):
- ident=self.CCident();
- chip=self.CCversions.get(ident&0xFF00);
- return "%s/r%02x" % (chip, ident&0xFF);
- def CCident(self):
- """Get a chipcon's ID."""
- self.writecmd(0x30,0x8B,0,None);
- chip=ord(self.data[0]);
- rev=ord(self.data[1]);
- return (chip<<8)+rev;
- def CCgetPC(self):
- """Get a chipcon's PC."""
- self.writecmd(0x30,0x83,0,None);
- hi=ord(self.data[0]);
- lo=ord(self.data[1]);
- return (hi<<8)+lo;
- 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];
- self.writecmd(0x30,0x90,2,self.data);
- return ord(self.data[0]);
- def CCpeekdatabyte(self,adr):
- """Read the contents of data memory at an address."""
- self.data=[adr&0xff, (adr&0xff00)>>8];
- self.writecmd(0x30,0x91, 2, self.data);
- return ord(self.data[0]);
- def CCpokedatabyte(self,adr,val):
- """Write a byte to data memory."""
- self.data=[adr&0xff, (adr&0xff00)>>8, val];
- self.writecmd(0x30, 0x92, 3, self.data);
- return ord(self.data[0]);
- def CCchiperase(self):
- """Erase all of the target's memory."""
- self.writecmd(0x30,0x80,0,None);
- def CCstatus(self):
- """Check the status."""
- self.writecmd(0x30,0x84,0,None);
- return ord(self.data[0])
- CCstatusbits={0x80 : "erased",
- 0x40 : "pcon_idle",
- 0x20 : "halted",
- 0x10 : "pm0",
- 0x08 : "halted",
- 0x04 : "locked",
- 0x02 : "oscstable",
- 0x01 : "overflow"};
- def CCstatusstr(self):
- """Check the status as a string."""
- status=self.CCstatus();
- str="";
- i=1;
- while i<0x100:
- if(status&i):
- 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();
- self.CCreleasecpu();
- self.CChaltcpu();
- #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])!";
-
-
- #print "Status: %s." % self.CCstatusstr();
- #Exit debugger
- self.CCstop();
- print "Done.";
+ def peek32(self,address, memory="vn"):
+ return (self.peek16(address,memory)+
+ (self.peek16(address+2,memory)<<16));
+ def peek16(self,address, memory="vn"):
+ return (self.peek8(address,memory)+
+ (self.peek8(address+1,memory)<<8));
+ def peek8(self,address, memory="vn"):
+ return self.peekbyte(address); #monitor
+ def loadsymbols(self):
+ return;