git.rot13.org Git - goodfet/blob - client/GoodFET.py

   1 #!/usr/bin/env python
   2 # GoodFET Client Library
   3 #
   4 # (C) 2009 Travis Goodspeed <travis at radiantmachines.com>
   5 #
   6 # This code is ugly as sin, for bootstrapping the firmware only.
   7 # Rewrite cleanly as soon as is convenient.
   8
   9 import sys, time, string, cStringIO, struct
  10 sys.path.append("/usr/lib/tinyos")
  11 import serial
  12
  13
  14 class GoodFET:
  15     def __init__(self, *args, **kargs):
  16         self.data=[0];
  17     def timeout(self):
  18         print "timout\n";
  19     def serInit(self, port):
  20         """Open the serial port"""
  21         self.serialport = serial.Serial(
  22             port,
  23             #9600,
  24             115200,
  25             parity = serial.PARITY_NONE
  26             )
  27         #Drop DTR, which is !RST, low to begin the app.
  28         self.serialport.setDTR(0);
  29         self.serialport.flushInput()
  30         self.serialport.flushOutput()
  31
  32         #Read and handle the initial command.
  33         #time.sleep(1);
  34         self.readcmd(); #Read the first command.
  35         if(self.verb!=0x7F):
  36             print "Verb is wrong.  Incorrect firmware?";
  37
  38     def writecmd(self, app, verb, count, data):
  39         """Write a command and some data to the GoodFET."""
  40         self.serialport.write(chr(app));
  41         self.serialport.write(chr(verb));
  42         self.serialport.write(chr(count));
  43         #print "count=%02x, len(data)=%04x" % (count,len(data));
  44         if count!=0:
  45             for d in data:
  46                 self.serialport.write(chr(d));
  47         self.readcmd();  #Uncomment this later, to ensure a response.
  48     def readcmd(self):
  49         """Read a reply from the GoodFET."""
  50         self.app=ord(self.serialport.read(1));
  51         self.verb=ord(self.serialport.read(1));
  52         self.count=ord(self.serialport.read(1));
  53         if self.count>0:
  54             self.data=self.serialport.read(self.count);
  55         #print "READ %02x %02x %02x " % (self.app, self.verb, self.count);
  56
  57     #Monitor stuff
  58     def peekbyte(self,address):
  59         """Read a byte of memory from the monitor."""
  60         self.data=[address&0xff,address>>8];
  61         self.writecmd(0,0x02,2,self.data);
  62         #self.readcmd();
  63         return ord(self.data[0]);
  64     def peekword(self,address):
  65         """Read a word of memory from the monitor."""
  66         return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
  67     def pokebyte(self,address,value):
  68         """Set a byte of memory by the monitor."""
  69         self.data=[address&0xff,address>>8,value];
  70         self.writecmd(0,0x03,3,self.data);
  71         return ord(self.data[0]);
  72     def setBaud(self,baud):
  73         rates=[9600, 9600, 19200, 38400];
  74         self.data=[baud];
  75         print "Changing FET baud."
  76         self.serialport.write(chr(0x00));
  77         self.serialport.write(chr(0x80));
  78         self.serialport.write(chr(1));
  79         self.serialport.write(chr(baud));
  80
  81         print "Changed host baud."
  82         self.serialport.setBaudrate(rates[baud]);
  83         time.sleep(1);
  84         self.serialport.flushInput()
  85         self.serialport.flushOutput()
  86
  87         print "Baud is now %i." % rates[baud];
  88         return;
  89     def monitortest(self):
  90         """Self-test several functions through the monitor."""
  91         print "Performing monitor self-test.";
  92
  93         if self.peekword(0x0c00)!=0x0c04:
  94             print "ERROR Fetched wrong value from 0x0c04.";
  95         self.pokebyte(0x0021,0); #Drop LED
  96         if self.peekbyte(0x0021)!=0:
  97             print "ERROR, P1OUT not cleared.";
  98         self.pokebyte(0x0021,1); #Light LED
  99
 100         print "Self-test complete.";
 101
 102     def spisetup(self):
 103         """Moved the FET into the SPI application."""
 104         self.writecmd(1,0x10,0,self.data); #SPI/SETUP
 105         #self.readcmd();
 106     def spitrans8(self,byte):
 107         """Read and write 8 bits by SPI."""
 108         self.data=[byte];
 109         self.writecmd(1,0,1,self.data);    #SPI exchange
 110         #self.readcmd();
 111
 112         if self.app!=1 or self.verb!=0:
 113             print "Error in SPI transaction; app=%02x, verb=%02x" % (self.app, self.verb);
 114         return ord(self.data[0]);
 115     def MSP430setup(self):
 116         """Move the FET into the MSP430 JTAG application."""
 117         print "Initializing MSP430.";
 118         self.writecmd(0x11,0x10,0,self.data);
 119     def CCsetup(self):
 120         """Move the FET into the CC2430/CC2530 application."""
 121         print "Initializing Chipcon.";
 122         self.writecmd(0x30,0x10,0,self.data);
 123     def CCrd_config(self):
 124         """Read the config register of a Chipcon."""
 125         self.writecmd(0x30,0x82,0,self.data);
 126         return ord(self.data[0]);
 127     def CCwr_config(self,config):
 128         """Write the config register of a Chipcon."""
 129         self.writecmd(0x30,0x81,1,[config&0xFF]);
 130
 131     CCversions={0x0100:"CC1110",
 132                 0x8500:"CC2430",
 133                 0x8900:"CC2431",
 134                 0x8100:"CC2510",
 135                 0x9100:"CC2511"};
 136     def CCidentstr(self):
 137         ident=self.CCident();
 138         chip=self.CCversions[ident&0xFF00];
 139         return "%s/r%02x" % (chip, ident&0xFF);
 140     def CCident(self):
 141         """Get a chipcon's ID."""
 142         self.writecmd(0x30,0x8B,0,None);
 143         chip=ord(self.data[0]);
 144         rev=ord(self.data[1]);
 145         return (chip<<8)+rev;
 146     def CCgetPC(self):
 147         """Get a chipcon's PC."""
 148         self.writecmd(0x30,0x83,0,None);
 149         hi=ord(self.data[0]);
 150         lo=ord(self.data[1]);
 151         return (hi<<8)+lo;
 152     def MSP430peek(self,adr):
 153         """Read the contents of memory at an address."""
 154         self.data=[adr&0xff, (adr&0xff00)>>8];
 155         self.writecmd(0x11,0x02,2,self.data);
 156         return ord(self.data[0])+(ord(self.data[1])<<8);
 157     def MSP430poke(self,adr,val):
 158         """Read the contents of memory at an address."""
 159         self.data=[adr&0xff, (adr&0xff00)>>8, val&0xff, (val&0xff00)>>8];
 160         self.writecmd(0x11,0x03,4,self.data);
 161         return;# ord(self.data[0])+(ord(self.data[1])<<8);
 162     def MSP430start(self):
 163         """Start debugging."""
 164         self.writecmd(0x11,0x20,0,self.data);
 165         ident=self.MSP430ident();
 166         print "Target identifies as %04x." % ident;
 167
 168     def CCstart(self):
 169         """Start debugging."""
 170         self.writecmd(0x30,0x20,0,self.data);
 171         ident=self.CCidentstr();
 172         print "Target identifies as %s." % ident;
 173     def CCstop(self):
 174         """Stop debugging."""
 175         self.writecmd(0x30,0x21,0,self.data);
 176     def CCstep_instr(self):
 177         """Step one instruction."""
 178         self.writecmd(0x30,0x89,0,self.data);
 179     def MSP430stop(self):
 180         """Stop debugging."""
 181         self.writecmd(0x11,0x21,0,self.data);
 182     def MSP430haltcpu(self):
 183         """Halt the CPU."""
 184         self.writecmd(0x11,0xA0,0,self.data);
 185     def MSP430releasecpu(self):
 186         """Resume the CPU."""
 187         self.writecmd(0x11,0xA1,0,self.data);
 188
 189     def MSP430shiftir8(self,ins):
 190         """Shift the 8-bit Instruction Register."""
 191         data=[ins];
 192         self.writecmd(0x11,0x80,1,data);
 193         return ord(self.data[0]);
 194     def MSP430shiftdr16(self,dat):
 195         """Shift the 16-bit Data Register."""
 196         data=[dat&0xFF,(dat&0xFF00)>>8];
 197         self.writecmd(0x11,0x81,2,data);
 198         return ord(self.data[0])#+(ord(self.data[1])<<8);
 199     def MSP430setinstrfetch(self):
 200         """Set the instruction fetch mode."""
 201         self.writecmd(0x11,0xC1,0,self.data);
 202         return self.data[0];
 203     def MSP430ident(self):
 204         """Grab self-identification word from 0x0FF0 as big endian."""
 205         i=self.MSP430peek(0x0ff0);
 206         return ((i&0xFF00)>>8)+((i&0xFF)<<8)
 207     def MSP430test(self):
 208         """Test MSP430 JTAG.  Requires that a chip be attached."""
 209         if self.MSP430ident()==0xffff:
 210             print "Is anything connected?";
 211         print "Testing RAM.";
 212         temp=self.MSP430peek(0x0200);
 213         self.MSP430poke(0x0200,0xdead);
 214         if(self.MSP430peek(0x0200)!=0xdead):
 215             print "Poke of 0x0200 did not set to 0xDEAD properly.";
 216             return;
 217         self.MSP430poke(0x0200,temp); #restore old value.
 218     def MSP430flashtest(self):
 219         self.MSP430masserase();
 220         i=0x2500;
 221         while(i<0xFFFF):
 222             if(self.MSP430peek(i)!=0xFFFF):
 223                 print "ERROR: Unerased flash at %04x."%i;
 224             self.MSP430writeflash(i,0xDEAD);
 225             i+=2;
 226     def MSP430masserase(self):
 227         """Erase MSP430 flash memory."""
 228         self.writecmd(0x11,0xE3,0,None);
 229     def MSP430writeflash(self,adr,val):
 230         """Write a word of flash memory."""
 231         if(self.MSP430peek(adr)!=0xFFFF):
 232             print "FLASH ERROR: %04x not clear." % adr;
 233         data=[adr&0xFF,(adr&0xFF00)>>8,val&0xFF,(val&0xFF00)>>8];
 234         self.writecmd(0x11,0xE1,4,data);
 235         rval=ord(self.data[0])+(ord(self.data[1])<<8);
 236         if(val!=rval):
 237             print "FLASH WRITE ERROR AT %04x.  Found %04x, wrote %04x." % (adr,rval,val);
 238
 239     def MSP430dumpbsl(self):
 240         self.MSP430dumpmem(0xC00,0xfff);
 241     def MSP430dumpallmem(self):
 242         self.MSP430dumpmem(0x200,0xffff);
 243     def MSP430dumpmem(self,begin,end):
 244         i=begin;
 245         while i<end:
 246             print "%04x %04x" % (i, self.MSP430peek(i));
 247             i+=2;
 248     def CCtest(self):
 249         #Grab ident three times, should be equal.
 250         ident1=self.CCident();
 251         ident2=self.CCident();
 252         ident3=self.CCident();
 253         if(ident1!=ident2 or ident2!=ident3):
 254             print "Error, repeated ident attempts unequal."
 255             print "%04x, %04x, %04x" % (ident1, ident2, ident3);
 256
 257         #Single step, printing PC.
 258         print "Tracing execution at startup."
 259         for i in range(1,15):
 260             print "PC=%04x" % self.CCgetPC();
 261             self.CCstep_instr();
 262         #Exit debugger
 263         self.CCstop();
 264         print "Done.";