X-Git-Url: http://git.rot13.org/?p=goodfet;a=blobdiff_plain;f=client%2FGoodFET.py;h=518cf47cc89385eb549ee64e15142a8afebdb433;hp=36f680e4b29a7e4dc94bfac4b96deffc6fdf9ca9;hb=64ef261d7416ef8cb3ec6cdf7130fc4d8afad8cd;hpb=46b8f7ea95b0a9815c40331c692f4346cfba33ee

diff --git a/client/GoodFET.py b/client/GoodFET.py
index 36f680e..518cf47 100755
--- a/client/GoodFET.py
+++ b/client/GoodFET.py
@@ -3,27 +3,99 @@
 # 
 # (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;
+import sqlite3;
 
+fmt = ("B", "<H", None, "<L")
+
+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 GoodFETMSP430.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"""
+
+    besilent=0;
+    app=0;
+    verb=0;
+    count=0;
+    data="";
+    verbose=False
+    
+    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 "timout\n";
-    def serInit(self, port):
+        print "timeout\n";
+    def serInit(self, port=None, timeout=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,
             115200,
-            parity = serial.PARITY_NONE
+            parity = serial.PARITY_NONE,
+            timeout=timeout
             )
+        
+        #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()
@@ -33,28 +105,134 @@ class GoodFET:
         #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 or bad Info guess?" % self.verb;
+            print "http://goodfet.sf.net/faq/";
+        #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));
+        
+        #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));
+
+        if self.verbose:
+            print "Tx: ( 0x%02x, 0x%02x, 0x%04x )" % ( app, verb, count )
+        
         #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.
+            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:
+            return self.readcmd()
+        else:
+            return []
+
     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:#self.serialport.inWaiting(): # Loop while input data is available
+            try:
+                #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)
+                    );
+
+                if self.verbose:
+                    print "Rx: ( 0x%02x, 0x%02x, 0x%04x )" % ( self.app, self.verb, self.count )
+            
+                #Debugging string; print, but wait.
+                if self.app==0xFF:
+                    if self.verb==0xFF:
+                        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]
+                    sys.stdout.flush();
+                else:
+                    self.data=self.serialport.read(self.count);
+                    return self.data;
+            except TypeError:
+                print "Error: waiting for serial read timed out (most likely)."
+                sys.exit(-1)
+
+    #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];
@@ -69,8 +247,30 @@ class GoodFET:
         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));
@@ -86,11 +286,26 @@ class GoodFET:
         
         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:
@@ -99,166 +314,51 @@ class GoodFET:
         
         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);
-        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);
-    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"};
-    def CCidentstr(self):
-        ident=self.CCident();
-        chip=self.CCversions[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 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 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;
-    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);
+    # The following functions ought to be implemented in
+    # every client.
 
-    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):
-        #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):
-            print "PC=%04x" % self.CCgetPC();
-            self.CCstep_instr();
-        #Exit debugger
-        self.CCstop();
-        print "Done.";
+    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 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;