MSP430X2 support is sufficient to read memory!
[goodfet] / client / GoodFET.py
index 2311062..912c9a6 100755 (executable)
@@ -3,13 +3,13 @@
 # 
 # (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
+import sys, time, string, cStringIO, struct, glob, serial, os;
 
 
 class GoodFET:
+    """GoodFET Client Library"""
     def __init__(self, *args, **kargs):
         self.data=[0];
     def timeout(self):
@@ -17,6 +17,10 @@ class GoodFET:
     def serInit(self, port=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:
@@ -28,13 +32,7 @@ class GoodFET:
         
         self.serialport = serial.Serial(
             port,
-            #300,
-            #2400,
-            #4800,
             #9600,
-            #19200,
-            #38400,
-            #57600,
             115200,
             parity = serial.PARITY_NONE
             )
@@ -48,8 +46,8 @@ class GoodFET:
         self.readcmd(); #Read the first command.
         if(self.verb!=0x7F):
             print "Verb %02x is wrong.  Incorrect firmware?" % self.verb;
-        print "Connected."
-    def writecmd(self, app, verb, count, data):
+        #print "Connected."
+    def writecmd(self, app, verb, count=0, data=[], blocks=1):
         """Write a command and some data to the GoodFET."""
         self.serialport.write(chr(app));
         self.serialport.write(chr(verb));
@@ -58,15 +56,16 @@ class GoodFET:
         if count!=0:
             for d in data:
                 self.serialport.write(chr(d));
-        self.readcmd();  #Uncomment this later, to ensure a response.
-    def readcmd(self):
+        
+        self.readcmd(blocks);  #Uncomment this later, to ensure a response.
+    def readcmd(self,blocks=1):
         """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);
+        self.data=self.serialport.read(self.count*blocks);
         #print "READ %02x %02x %02x " % (self.app, self.verb, self.count);
+        return self.data;
         
     #Monitor stuff
     def peekbyte(self,address):
@@ -141,7 +140,7 @@ class GoodFET:
         """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:
@@ -150,8 +149,28 @@ class GoodFET:
         
         print "Self-test complete.";
     
+    
+
+    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]);
+class GoodFETSPI(GoodFET):
     def SPIsetup(self):
-        """Moved the FET into the SPI application."""
+        """Move the FET into the SPI application."""
         self.writecmd(0x01,0x10,0,self.data); #SPI/SETUP
         
     def SPItrans8(self,byte):
@@ -164,7 +183,8 @@ class GoodFET:
         self.data=data;
         self.writecmd(0x01,0x00,len(data),data);
         return self.data;
-    
+
+class GoodFETSPIFlash(GoodFETSPI):
     JEDECmanufacturers={0xFF: "MISSING",
                         0xEF: "Winbond",
                         0xC2: "MXIC",
@@ -180,6 +200,12 @@ class GoodFET:
                   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];
@@ -188,6 +214,9 @@ class GoodFET:
         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):
@@ -199,13 +228,14 @@ class GoodFET:
               0];
         self.SPItrans(data);
         return ord(self.data[4]);
-    def SPIpeekblock(self,adr):
-        """Grab a byte from an SPI Flash ROM."""
+    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];
+              adr&0xFF,
+              blocks];
         
-        self.writecmd(0x01,0x02,3,data);
+        self.writecmd(0x01,0x02,4,data,blocks);
         return self.data;
     
     def SPIpokebyte(self,adr,val):
@@ -243,16 +273,52 @@ class GoodFET:
         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);
 
-    
-    
+class GoodFETCC(GoodFET):
+    """A GoodFET variant for use with Chipcon 8051 Zigbe SoC."""
+    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 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 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."""
@@ -287,11 +353,6 @@ class GoodFET:
     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];
@@ -332,17 +393,6 @@ class GoodFET:
                 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);
@@ -351,7 +401,7 @@ class GoodFET:
         #print "Status: %s." % self.CCstatusstr();
         self.CCreleasecpu();
         self.CChaltcpu();
-        print "Status: %s." % self.CCstatusstr();
+        #print "Status: %s." % self.CCstatusstr();
         
     def CCstop(self):
         """Stop debugging."""
@@ -359,114 +409,4 @@ class GoodFET:
     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])!";
-        for i in range(0xE500,0xE600):
-            byte=self.CCpeekdatabyte(i);
-            print "data %04x: %02x" % (i,byte);
-            self.CCpokedatabyte(i,i&0xFF);
-            byte=self.CCpeekdatabyte(i);
-            print "data %04x: %02x" % (i,byte);
-        print "Status: %s." % self.CCstatusstr();
-        #Exit debugger
-        self.CCstop();
-        print "Done.";
+