#
# This code is being rewritten and refactored. You've been warned!
-import sys, time, string, cStringIO, struct, glob, serial, os;
+import sys, time, string, cStringIO, struct, glob, os;
import sqlite3;
fmt = ("B", "<H", None, "<L")
def getClient(name="GoodFET"):
- import GoodFET, GoodFETCC, GoodFETAVR, GoodFETSPI, GoodFETMSP430, GoodFETNRF;
+ import GoodFET, GoodFETCC, GoodFETAVR, GoodFETSPI, GoodFETMSP430, GoodFETNRF, GoodFETCCSPI;
if(name=="GoodFET" or name=="monitor"): return GoodFET.GoodFET();
- elif name=="cc" or name=="chipcon": return GoodFETCC.GoodFETCC();
+ elif name=="cc" or name=="cc51": return GoodFETCC.GoodFETCC();
+ elif name=="cc2420" or name=="ccspi": return GoodFETCCSPI.GoodFETCCSPI();
elif name=="avr": return GoodFETAVR.GoodFETAVR();
elif name=="spi": return GoodFETSPI.GoodFETSPI();
elif name=="msp430": return GoodFETMSP430.GoodFETMSP430();
"values(?,?,?,?,?);", (
adr,name,memory,size,comment));
#print "Set %s=%s." % (name,adr);
+class GoodFETbtser:
+ """py-bluez class for emulating py-serial."""
+ def __init__(self,btaddr):
+ import bluetooth;
+ if btaddr==None or btaddr=="none" or btaddr=="bluetooth":
+ print "performing inquiry..."
+ nearby_devices = bluetooth.discover_devices(lookup_names = True)
+ print "found %d devices" % len(nearby_devices)
+ for addr, name in nearby_devices:
+ print " %s - '%s'" % (addr, name)
+ #TODO switch to wildcards.
+ if name=='FireFly-A6BD':
+ btaddr=addr;
+ if name=='RN42-A94A':
+ btaddr=addr;
+
+ print "Please set $GOODFET to the address of your device.";
+ sys.exit();
+ print "Identified GoodFET at %s" % btaddr;
+ # Manually use the portnumber.
+ port=1;
+
+ print "Connecting to %s on port %i." % (btaddr, port);
+ sock=bluetooth.BluetoothSocket(bluetooth.RFCOMM);
+ self.sock=sock;
+ sock.connect((btaddr,port));
+ sock.settimeout(10); #IMPORTANT Must be patient.
+
+ ##This is what we'd do for a normal reset.
+ #str="";
+ #while not str.endswith("goodfet.sf.net/"):
+ # str=self.read(64);
+ # print str;
+
+ # Instead, just return and hope for the best.
+ return;
+
+ def write(self,msg):
+ """Send traffic."""
+ import time;
+ self.sock.send(msg);
+ #time.sleep(0.1);
+ return;
+ def read(self,length):
+ """Read traffic."""
+ data="";
+ while len(data)<length:
+ data=data+self.sock.recv(length-len(data));
+ return data;
class GoodFET:
"""GoodFET Client Library"""
return self.symbols.get(name);
def timeout(self):
print "timeout\n";
- def serInit(self, port=None, timeout=2):
+ def serInit(self, port=None, timeout=2, attemptlimit=None):
+ """Open a serial port of some kind."""
+ import re;
+
+ if port==None:
+ port=os.environ.get("GOODFET");
+ if port=="bluetooth" or (port is not None and re.match("..:..:..:..:..:..",port)):
+ self.btInit(port,2,attemptlimit);
+ else:
+ self.pyserInit(port,timeout,attemptlimit);
+ def btInit(self, port, timeout, attemptlimit):
+ """Open a bluetooth port.""";
+ #self.verbose=True; #For debugging BT.
+ self.serialport=GoodFETbtser(port);
+
+ def pyserInit(self, port, timeout, attemptlimit):
"""Open the serial port"""
# Make timeout None to wait forever, 0 for non-blocking mode.
+ import serial;
+ fixserial=False;
+
+ if os.name=='nt' and sys.version.find('64 bit')!=-1:
+ print "WARNING: PySerial requires a 32-bit Python build in Windows.";
if port is None and os.environ.get("GOODFET")!=None:
glob_list = glob.glob(os.environ.get("GOODFET"));
glob_list = glob.glob("/dev/ttyUSB*");
if len(glob_list) > 0:
port = glob_list[0];
- if os.name=='nt':
+ if port is None:
+ glob_list = glob.glob("/dev/ttyU0");
+ if len(glob_list) > 0:
+ port = glob_list[0];
+ if port is None and os.name=='nt':
from scanwin32 import winScan;
scan=winScan();
for order,comport,desc,hwid in sorted(scan.comports()):
- if hwid.index('FTDI')==0:
- port=comport;
- #print "Using FTDI port %s" % port
-
+ try:
+ if hwid.index('FTDI')==0:
+ port=comport;
+ #print "Using FTDI port %s" % port
+ except:
+ #Do nothing.
+ a=1;
+ baud=115200;
+ if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
+ baud=19200; #Slower, for now.
self.serialport = serial.Serial(
port,
#9600,
- 115200,
+ baud,
parity = serial.PARITY_NONE,
timeout=timeout
)
connected=0;
while connected==0:
while self.verb!=0x7F or self.data!="http://goodfet.sf.net/":
- #print "Resyncing.";
- self.serialport.flushInput()
- self.serialport.flushOutput()
- #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()
- self.serialport.flushOutput()
+ #while self.data!="http://goodfet.sf.net/":
+ #print "'%s'!=\n'%s'" % (self.data,"http://goodfet.sf.net/");
+ if attemptlimit is not None and attempts >= attemptlimit:
+ return
+ elif attempts==2 and os.environ.get("board")!='telosb':
+ print "See the GoodFET FAQ about missing info flash.";
+ self.serialport.setTimeout(0.2);
+ #self.serialport.flushInput()
+ #self.serialport.flushOutput()
+
+ #TelosB reset, prefer software to I2C SPST Switch.
+ if (os.environ.get("board")=='telosb'):
+ #print "TelosB Reset";
+ self.telosBReset();
+ elif (os.environ.get("board")=='z1'):
+ self.bslResetZ1(invokeBSL=0);
+ elif (os.environ.get("board")=='apimote1') or (os.environ.get("board")=='apimote'):
+ #Explicitly set RTS and DTR to halt board.
+ self.serialport.setRTS(1);
+ self.serialport.setDTR(1);
+ #RTS pin, not DTR is used for reset.
+ self.serialport.setRTS(0);
+ #print "Resetting Apimote not yet tested.";
+ else:
+ #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.write(chr(0x80));
+ #self.serialport.write(chr(0x80));
+ #self.serialport.write(chr(0x80));
+ #self.serialport.write(chr(0x80));
+
+
+ #self.serialport.flushInput()
+ #self.serialport.flushOutput()
#time.sleep(60);
attempts=attempts+1;
self.readcmd(); #Read the first command.
+ #print "Got %02x,%02x:'%s'" % (self.app,self.verb,self.data);
+ if self.verb!=0x7f:
+ #Retry again. This usually times out, but helps connect.
+ self.readcmd();
+ #print "Retry got %02x,%02x:'%s'" % (self.app,self.verb,self.data);
#Here we have a connection, but maybe not a good one.
+ #print "We have a connection."
connected=1;
olds=self.infostring();
clocking=self.monitorclocking();
for foo in range(1,30):
if not self.monitorecho():
- if self.verbose: print "Comm error on %i try, resyncing out of %s." % (foo,
- clocking);
+ if self.verbose:
+ print "Comm error on %i try, resyncing out of %s." % (foo,
+ clocking);
connected=0;
break;
if self.verbose: print "Connected after %02i attempts." % attempts;
self.mon_connected();
+ self.serialport.setTimeout(12);
+ def serClose(self):
+ self.serialport.close();
+ def telosSetSCL(self, level):
+ self.serialport.setRTS(not level)
+ def telosSetSDA(self, level):
+ self.serialport.setDTR(not level)
+
+ def telosI2CStart(self):
+ self.telosSetSDA(1)
+ self.telosSetSCL(1)
+ self.telosSetSDA(0)
+
+ def telosI2CStop(self):
+ self.telosSetSDA(0)
+ self.telosSetSCL(1)
+ self.telosSetSDA(1)
+
+ def telosI2CWriteBit(self, bit):
+ self.telosSetSCL(0)
+ self.telosSetSDA(bit)
+ time.sleep(2e-6)
+ self.telosSetSCL(1)
+ time.sleep(1e-6)
+ self.telosSetSCL(0)
+
+ def telosI2CWriteByte(self, byte):
+ self.telosI2CWriteBit( byte & 0x80 );
+ self.telosI2CWriteBit( byte & 0x40 );
+ self.telosI2CWriteBit( byte & 0x20 );
+ self.telosI2CWriteBit( byte & 0x10 );
+ self.telosI2CWriteBit( byte & 0x08 );
+ self.telosI2CWriteBit( byte & 0x04 );
+ self.telosI2CWriteBit( byte & 0x02 );
+ self.telosI2CWriteBit( byte & 0x01 );
+ self.telosI2CWriteBit( 0 ); # "acknowledge"
+
+ def telosI2CWriteCmd(self, addr, cmdbyte):
+ self.telosI2CStart()
+ self.telosI2CWriteByte( 0x90 | (addr << 1) )
+ self.telosI2CWriteByte( cmdbyte )
+ self.telosI2CStop()
+ def bslResetZ1(self, invokeBSL=0):
+ '''
+ Applies BSL entry sequence on RST/NMI and TEST/VPP pins
+ Parameters:
+ invokeBSL = 1: complete sequence
+ invokeBSL = 0: only RST/NMI pin accessed
+
+ By now only BSL mode is accessed
+ '''
+ #if DEBUG > 1: sys.stderr.write("* bslReset(invokeBSL=%s)\n" % invokeBSL)
+ if invokeBSL:
+ #sys.stderr.write("in Z1 bsl reset...\n")
+ time.sleep(0.1)
+ self.writepicROM(0xFF, 0xFF)
+ time.sleep(0.1)
+ #sys.stderr.write("z1 bsl reset done...\n")
+ else:
+ #sys.stderr.write("in Z1 reset...\n")
+ time.sleep(0.1)
+ self.writepicROM(0xFF, 0xFE)
+ time.sleep(0.1)
+ #sys.stderr.write("z1 reset done...\n")
+ def writepicROM(self, address, data):
+ ''' Writes data to @address'''
+ for i in range(7,-1,-1):
+ self.picROMclock((address >> i) & 0x01)
+ self.picROMclock(0)
+ recbuf = 0
+ for i in range(7,-1,-1):
+ s = ((data >> i) & 0x01)
+ #print s
+ if i < 1:
+ r = not self.picROMclock(s, True)
+ else:
+ r = not self.picROMclock(s)
+ recbuf = (recbuf << 1) + r
+
+ self.picROMclock(0, True)
+ #k = 1
+ #while not self.serial.getCTS():
+ # pass
+ #time.sleep(0.1)
+ return recbuf
+ def readpicROM(self, address):
+ ''' reads a byte from @address'''
+ for i in range(7,-1,-1):
+ self.picROMclock((address >> i) & 0x01)
+ self.picROMclock(1)
+ recbuf = 0
+ r = 0
+ for i in range(7,-1,-1):
+ r = self.picROMclock(0)
+ recbuf = (recbuf << 1) + r
+ self.picROMclock(r)
+ #time.sleep(0.1)
+ return recbuf
+
+ #This seems more reliable when slowed.
+ def picROMclock(self, masterout, slow = True):
+ #print "setting masterout to "+str(masterout)
+ self.serialport.setRTS(masterout)
+ self.serialport.setDTR(1)
+ #time.sleep(0.02)
+ self.serialport.setDTR(0)
+ if slow:
+ time.sleep(0.02)
+ return self.serialport.getCTS()
+
+ def picROMfastclock(self, masterout):
+ #print "setting masterout to "+str(masterout)
+ self.serialport.setRTS(masterout)
+ self.serialport.setDTR(1)
+ self.serialport.setDTR(0)
+ time.sleep(0.02)
+ return self.serialport.getCTS()
+
+ def telosBReset(self,invokeBSL=0):
+ # "BSL entry sequence at dedicated JTAG pins"
+ # rst !s0: 0 0 0 0 1 1
+ # tck !s1: 1 0 1 0 0 1
+ # s0|s1: 1 3 1 3 2 0
+
+ # "BSL entry sequence at shared JTAG pins"
+ # rst !s0: 0 0 0 0 1 1
+ # tck !s1: 0 1 0 1 1 0
+ # s0|s1: 3 1 3 1 0 2
+
+ if invokeBSL:
+ self.telosI2CWriteCmd(0,1)
+ self.telosI2CWriteCmd(0,3)
+ self.telosI2CWriteCmd(0,1)
+ self.telosI2CWriteCmd(0,3)
+ self.telosI2CWriteCmd(0,2)
+ self.telosI2CWriteCmd(0,0)
+ else:
+ self.telosI2CWriteCmd(0,3)
+ self.telosI2CWriteCmd(0,2)
+
+ # This line was not defined inside the else: block, not sure where it
+ # should be however
+ self.telosI2CWriteCmd(0,0)
+ time.sleep(0.250) #give MSP430's oscillator time to stabilize
+ self.serialport.flushInput() #clear buffers
+
+
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]);
try:
#print "Reading...";
self.app=ord(self.serialport.read(1));
- #print "APP=%2x" % self.app;
+ #print "APP=%02x" % self.app;
self.verb=ord(self.serialport.read(1));
+
+ #Fixes an obscure bug in the TelosB.
+ if self.app==0x00:
+ while self.verb==0x00:
+ self.verb=ord(self.serialport.read(1));
+
#print "VERB=%02x" % self.verb;
self.count=(
ord(self.serialport.read(1))
print "# DEBUG %s" % self.serialport.read(self.count)
elif self.verb==0xFE:
print "# DEBUG 0x%x" % struct.unpack(fmt[self.count-1], self.serialport.read(self.count))[0]
+ elif self.verb==0xFD:
+ #Do nothing, just wait so there's no timeout.
+ print "# NOP.";
+
sys.stdout.flush();
else:
self.data=self.serialport.read(self.count);
return self.data;
except TypeError:
if self.connected:
- print "Error: waiting for serial read timed out (most likely).";
- print "This shouldn't happen after syncing. Exiting for safety.";
- sys.exit(-1)
+ print "Warning: waiting for serial read timed out (most likely).";
+ #print "This shouldn't happen after syncing. Exiting for safety.";
+ #sys.exit(-1)
return self.data;
#Glitching stuff.
def glitchApp(self,app):
"""Time the execution of a verb."""
if data==None: data=[];
self.data=[app&0xff, verb&0xFF]+data;
+ print "Timing app %02x verb %02x." % (app,verb);
self.writecmd(self.GLITCHAPP,0x82,len(self.data),self.data);
- return ord(self.data[0])+(ord(self.data[1])<<8);
+ time=ord(self.data[0])+(ord(self.data[1])<<8);
+ print "Timed to be %i." % time;
+ return time;
def glitchVoltages(self,low=0x0880, high=0x0fff):
"""Set glitching voltages. (0x0fff is max.)"""
self.data=[low&0xff, (low>>8)&0xff,
"""Execute supplied code."""
self.writecmd(0,0x31,2,#len(code),
code);
- def peekbyte(self,address):
+ def MONpeek8(self,address):
"""Read a byte of memory from the monitor."""
self.data=[address&0xff,address>>8];
self.writecmd(0,0x02,2,self.data);
#self.readcmd();
return ord(self.data[0]);
- def peekword(self,address):
+ def MONpeek16(self,address):
"""Read a word of memory from the monitor."""
- return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
- def pokebyte(self,address,value):
+ return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
+ def peek(self,address):
+ """Read a word of memory from the monitor."""
+ return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
+ def eeprompeek(self,address):
+ """Read a word of memory from the monitor."""
+ print "EEPROM peeking not supported for the monitor.";
+ #return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
+ def peekbysym(self,name):
+ """Read a value by its symbol name."""
+ #TODO include memory in symbol.
+ reg=self.symbols.get(name);
+ return self.peek8(reg,"data");
+ def pokebysym(self,name,val):
+ """Write a value by its symbol name."""
+ #TODO include memory in symbol.
+ reg=self.symbols.get(name);
+ return self.pokebyte(reg,val);
+ def pokebyte(self,address,value,memory="vn"):
"""Set a byte of memory by the monitor."""
self.data=[address&0xff,address>>8,value];
self.writecmd(0,0x03,3,self.data);
return ord(self.data[0]);
+ def poke16(self,address,value):
+ """Set a word of memory by the monitor."""
+ self.MONpoke16(address,value);
+ def MONpoke16(self,address,value):
+ """Set a word of memory by the monitor."""
+ self.pokebyte(address,value&0xFF);
+ self.pokebyte(address,(value>>8)&0xFF);
+ return value;
+ def setsecret(self,value):
+ """Set a secret word for later retreival. Used by glitcher."""
+ #self.eeprompoke(0,value);
+ #self.eeprompoke(1,value);
+ print "Secret setting is not yet suppored for this target.";
+ print "Aborting.";
+
+ def getsecret(self):
+ """Get a secret word. Used by glitcher."""
+ #self.eeprompeek(0);
+ print "Secret getting is not yet suppored for this target.";
+ print "Aborting.";
+ sys.exit();
+
def dumpmem(self,begin,end):
i=begin;
while i<end:
- print "%04x %04x" % (i, self.peekword(i));
+ print "%04x %04x" % (i, self.MONpeek16(i));
i+=2;
def monitor_ram_pattern(self):
"""Overwrite all of RAM with 0xBEEF."""
print "Performing monitor self-test.";
self.monitorclocking();
for f in range(0,3000):
- a=self.peekword(0x0c00);
- b=self.peekword(0x0c02);
+ a=self.MONpeek16(0x0c00);
+ b=self.MONpeek16(0x0c02);
if a!=0x0c04 and a!=0x0c06:
print "ERROR Fetched %04x, %04x" % (a,b);
self.pokebyte(0x0021,0); #Drop LED
- if self.peekbyte(0x0021)!=0:
+ if self.MONpeek8(0x0021)!=0:
print "ERROR, P1OUT not cleared.";
self.pokebyte(0x0021,1); #Light LED
if not self.monitorecho():
data="The quick brown fox jumped over the lazy dog.";
self.writecmd(self.MONITORAPP,0x81,len(data),data);
if self.data!=data:
- if self.verbose: print "Comm error recognized by monitorecho().";
+ if self.verbose:
+ print "Comm error recognized by monitorecho(), got:\n%s" % self.data;
return 0;
return 1;
- def monitorclocking(self):
- DCOCTL=self.peekbyte(0x0056);
- BCSCTL1=self.peekbyte(0x0057);
- return "0x%02x, 0x%02x" % (DCOCTL, BCSCTL1);
+ def monitor_info(self):
+ print "GoodFET with %s MCU" % self.infostring();
+ print "Clocked at %s" % self.monitorclocking();
+ return 1;
+
+ def testleds(self):
+ print "Flashing LEDs"
+ self.writecmd(self.MONITORAPP,0xD0,0,"")
+ try:
+ print "Flashed %d LED." % ord(self.data)
+ except:
+ print "Unable to process response:", self.data
+ return 1
+
+ def monitor_list_apps(self, full=False):
+ self.monitor_info()
+ old_value = self.besilent
+ self.besilent = True # turn off automatic call to readcmd
+ self.writecmd(self.MONITORAPP, 0x82, 1, [int(full)]);
+ self.besilent = old_value
+
+ # read the build date string
+ self.readcmd()
+ print "Build Date: %s" % self.data
+ print "Firmware apps:"
+ while True:
+ self.readcmd()
+ if self.count == 0:
+ break
+ print self.data
+ return 1;
+
+ def monitorclocking(self):
+ """Return the 16-bit clocking value."""
+ return "0x%04x" % self.monitorgetclock();
+
+ def monitorsetclock(self,clock):
+ """Set the clocking value."""
+ self.MONpoke16(0x56, clock);
+ def monitorgetclock(self):
+ """Get the clocking value."""
+ if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
+ return 0xDEAD;
+ #Check for MSP430 before peeking this.
+ return self.MONpeek16(0x56);
# The following functions ought to be implemented in
# every client.
-
+
def infostring(self):
- a=self.peekbyte(0xff0);
- b=self.peekbyte(0xff1);
- return "%02x%02x" % (a,b);
+ if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
+ return "Arduino";
+ else:
+ a=self.MONpeek8(0xff0);
+ b=self.MONpeek8(0xff1);
+ return "%02x%02x" % (a,b);
def lock(self):
print "Locking Unsupported.";
def erase(self):
"""Dump an intel hex file from code memory."""
print "Dump not implemented.";
def peek32(self,address, memory="vn"):
+ """Peek 32 bits."""
return (self.peek16(address,memory)+
(self.peek16(address+2,memory)<<16));
def peek16(self,address, memory="vn"):
+ """Peek 16 bits of memory."""
return (self.peek8(address,memory)+
(self.peek8(address+1,memory)<<8));
def peek8(self,address, memory="vn"):
- return self.peekbyte(address); #monitor
- def peekword(self,address, memory="vn"):
- return self.peek(address); #monitor
-
+ """Peek a byte of memory."""
+ return self.MONpeek8(address); #monitor
+ def peekblock(self,address,length,memory="vn"):
+ """Return a block of data."""
+ data=range(0,length);
+ for foo in range(0,length):
+ data[foo]=self.peek8(address+foo,memory);
+ return data;
+ def pokeblock(self,address,bytes,memory="vn"):
+ """Poke a block of a data into memory at an address."""
+ for foo in bytes:
+ self.pokebyte(address,foo,memory);
+ address=address+1;
+ return;
def loadsymbols(self):
+ """Load symbols from a file."""
return;