Getting closer to an I2C Python client.
[goodfet] / client / GoodFET.py
index 263e368..3a192fc 100755 (executable)
@@ -6,18 +6,30 @@
 # This code is ugly as sin, for bootstrapping the firmware only.
 # Rewrite cleanly as soon as is convenient.
 
-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:
     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:
+            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,
@@ -33,8 +45,8 @@ class GoodFET:
         #time.sleep(1);
         self.readcmd(); #Read the first command.
         if(self.verb!=0x7F):
-            print "Verb is wrong.  Incorrect firmware?";
-        
+            print "Verb %02x is wrong.  Incorrect firmware?" % self.verb;
+        #print "Connected."
     def writecmd(self, app, verb, count, data):
         """Write a command and some data to the GoodFET."""
         self.serialport.write(chr(app));
@@ -69,8 +81,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 +120,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,26 +148,125 @@ class GoodFET:
         
         print "Self-test complete.";
     
-    def spisetup(self):
+    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):
+        self.writecmd(0x01,0x10,0,self.data); #SPI/SETUP
+    
+        
+    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();
+        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"
+                        };
+
+    JEDECdevices={0xFFFFFF: "MISSING",
+                  0xEF3014: "W25X80L",
+                  0xEF3013: "W25X40L",
+                  0xEF3012: "W25X20L",
+                  0xEF3011: "W25X10L",
+                  0xC22014: "MX25L8005",
+                  0xC22013: "MX25L4005",
+                  0x204011: "M45PE10"
+                  };
+    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.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 byte from an SPI Flash ROM."""
+        data=[(adr&0xFF0000)>>16,
+              (adr&0xFF00)>>8,
+              adr&0xFF];
         
-        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]);
+        self.writecmd(0x01,0x02,3,data);
+        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 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.";
+        #print "Initializing Chipcon.";
         self.writecmd(0x30,0x10,0,self.data);
     def CCrd_config(self):
         """Read the config register of a Chipcon."""
@@ -127,23 +275,82 @@ class GoodFET:
     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);
@@ -153,12 +360,19 @@ class GoodFET:
     def CCstart(self):
         """Start debugging."""
         self.writecmd(0x30,0x20,0,self.data);
-        ident=self.CCident();
-        print "Target identifies as %04x." % ident;
+        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);
@@ -168,7 +382,12 @@ class GoodFET:
     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];
@@ -228,7 +447,36 @@ class GoodFET:
         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.";