Fixed a usage line of goodfet.nrf.
[goodfet] / client / GoodFET.py
index 48810af..4aec90b 100755 (executable)
@@ -6,28 +6,82 @@
 # This code is being rewritten and refactored.  You've been warned!
 
 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, GoodFETNRF;
+    if(name=="GoodFET" or name=="monitor"): return GoodFET.GoodFET();
+    elif name=="cc" or name=="cc51": return GoodFETCC.GoodFETCC();
+    elif name=="cc2420" or name=="ccspi": return GoodFETCC.GoodFETCC();
+    elif name=="avr": return GoodFETAVR.GoodFETAVR();
+    elif name=="spi": return GoodFETSPI.GoodFETSPI();
+    elif name=="msp430": return GoodFETMSP430.GoodFETMSP430();
+    elif name=="nrf": return GoodFETNRF.GoodFETNRF();
+    
+    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;
+    MONITORAPP=0x00;
+    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):
+    def serInit(self, port=None, timeout=2):
         """Open the serial port"""
+        # Make timeout None to wait forever, 0 for non-blocking mode.
         
         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];
+            else:
+                port = os.environ.get("GOODFET");
         if port is None:
             glob_list = glob.glob("/dev/tty.usbserial*");
             if len(glob_list) > 0:
@@ -36,31 +90,136 @@ class GoodFET:
             glob_list = glob.glob("/dev/ttyUSB*");
             if len(glob_list) > 0:
                 port = glob_list[0];
+        if os.name=='nt':
+            from scanwin32 import winScan;
+            scan=winScan();
+            for order,comport,desc,hwid in sorted(scan.comports()):
+                try:
+                    if hwid.index('FTDI')==0:
+                        port=comport;
+                        #print "Using FTDI port %s" % port
+                except:
+                    #Do nothing.
+                    a=1;
         
         self.serialport = serial.Serial(
             port,
             #9600,
             115200,
-            parity = serial.PARITY_NONE
+            parity = serial.PARITY_NONE,
+            timeout=timeout
             )
         
-        #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()
-        self.serialport.flushOutput()
-        
-        #Read and handle the initial command.
-        #time.sleep(1);
-        self.readcmd(); #Read the first command.
-        if(self.verb!=0x7F):
-            print "Verb %02x is wrong.  Incorrect firmware?" % self.verb;
-        #print "Connected."
+        self.verb=0;
+        attempts=0;
+        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);
+                
+                #TelosB reset, prefer software to I2C SPST Switch.
+                if(os.environ.get("platform")=='telosb'):
+                    self.telosBReset();
+                #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.
+            #Here we have a connection, but maybe not a good one.
+            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);
+                    connected=0;
+                    break;
+        if self.verbose: print "Connected after %02i attempts." % attempts;
+        self.mon_connected();
+        self.serialport.setTimeout(12);
+    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 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]);
@@ -77,6 +236,9 @@ class GoodFET:
         #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));
         
@@ -89,33 +251,46 @@ class GoodFET:
             outstr=''.join(data);
             self.serialport.write(outstr);
         if not self.besilent:
-            self.readcmd();
-        
-    besilent=0;
-    app=0;
-    verb=0;
-    count=0;
-    data="";
+            return self.readcmd()
+        else:
+            return []
 
     def readcmd(self):
         """Read a reply from the GoodFET."""
-        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)
-                );
+        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 and self.verb==0xFF:
-                print "# DEBUG %s" % self.serialport.read(self.count);
-                sys.stdout.flush();
-            else:
-                self.data=self.serialport.read(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]
+                    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 "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):
@@ -139,8 +314,11 @@ class GoodFET:
         """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,
@@ -161,7 +339,11 @@ class GoodFET:
         self.besilent=s;
         print "besilent is %i" % self.besilent;
         self.writecmd(0,0xB0,1,[s]);
-        
+    connected=0;
+    def mon_connected(self):
+        """Announce to the monitor that the connection is good."""
+        self.connected=1;
+        self.writecmd(0,0xB1,0,[]);
     def out(self,byte):
         """Write a byte to P5OUT."""
         self.writecmd(0,0xA1,1,[byte]);
@@ -185,11 +367,40 @@ class GoodFET:
     def peekword(self,address):
         """Read a word of memory from the monitor."""
         return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
-    def pokebyte(self,address,value):
+    def peek(self,address):
+        """Read a word of memory from the monitor."""
+        return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
+    def eeprompeek(self,address):
+        """Read a word of memory from the monitor."""
+        return self.peekbyte(address)+(self.peekbyte(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.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);
+    def getsecret(self):
+        """Get a secret word.  Used by glitcher."""
+        self.eeprompeek(0);
+    
     def dumpmem(self,begin,end):
         i=begin;
         while i<end:
@@ -247,20 +458,64 @@ class GoodFET:
     def monitortest(self):
         """Self-test several functions through the monitor."""
         print "Performing monitor self-test.";
-        
-        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 "ERROR, P1OUT not cleared.";
-        self.pokebyte(0x0021,1); #Light LED
-        
+        self.monitorclocking();
+        for f in range(0,3000):
+            a=self.peekword(0x0c00);
+            b=self.peekword(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:
+                print "ERROR, P1OUT not cleared.";
+            self.pokebyte(0x0021,1); #Light LED
+            if not self.monitorecho():
+                print "Echo test failed.";
         print "Self-test complete.";
+        self.monitorclocking();
+    def monitorecho(self):
+        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().";
+            return 0;
+        return 1;
+
+    def monitor_info(self):
+        print "GoodFET with %s MCU" % self.infostring();
+        print "Clocked at %s" % self.monitorclocking();
+        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.poke16(0x56, clock);
+    def monitorgetclock(self):
+        """Get the clocking value."""
+        return self.peek16(0x56);
     # The following functions ought to be implemented in
     # every client.
-
+    
     def infostring(self):
         a=self.peekbyte(0xff0);
         b=self.peekbyte(0xff1);
@@ -274,17 +529,52 @@ class GoodFET:
     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"):
+        """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 0xde;
+        """Peek a byte of memory."""
+        return self.peekbyte(address); #monitor
+    def peekword(self,address, memory="vn"):
+        """Peek a natively sized word of memory."""
+        return self.peek16(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;