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(0x01,0x10,0,self.data); #SPI/SETUP
 105         #self.readcmd();
 106     def SPItrans8(self,byte):
 107         """Read and write 8 bits by SPI."""
 108         data=self.SPItrans([byte]);
 109         return ord(data[0]);
 110
 111     def SPItrans(self,data):
 112         """Exchange data by SPI."""
 113         self.data=data;
 114         self.writecmd(0x01,0x00,len(data),data);
 115         return self.data;
 116
 117     JEDECmanufacturers={0xFF: "MISSING",
 118                         0xEF: "Winbond",
 119                         0xC2: "MXIC"};
 120
 121     JEDECdevices={0xFFFFFF: "MISSING",
 122                   0xEF3014: "W25X80L",
 123                   0xEF3013: "W25X40L",
 124                   0xEF3012: "W25X20L",
 125                   0xEF3011: "W25X10L",
 126                   0xC22014: "MX25L8005",
 127                   0xC22013: "MX25L4005"
 128                   };
 129     def SPIjedec(self):
 130         """Grab an SPI Flash ROM's JEDEC bytes."""
 131         data=[0x9f, 0, 0, 0];
 132         data=self.SPItrans(data);
 133         #print "Manufacturer: %02x\nType: %02x\nCapacity: %02x" % (ord(data[1]),ord(data[2]),ord(data[3]));
 134         self.JEDECmanufacturer=ord(data[1]);
 135         self.JEDECtype=ord(data[2]);
 136         self.JEDECcapacity=ord(data[3]);
 137         self.JEDECdevice=(ord(data[1])<<16)+(ord(data[2])<<8)+ord(data[3]);
 138         return data;
 139     def SPIpeek(self,adr):
 140         """Grab a byte from an SPI Flash ROM."""
 141         data=[0x03,
 142               (adr&0xFF0000)>>16,
 143               (adr&0xFF00)>>8,
 144               adr&0xFF,
 145               0];
 146         self.SPItrans(data);
 147         return ord(self.data[4]);
 148     def SPIpeekblock(self,adr):
 149         """Grab a byte from an SPI Flash ROM."""
 150         data=[(adr&0xFF0000)>>16,
 151               (adr&0xFF00)>>8,
 152               adr&0xFF];
 153
 154         self.writecmd(0x01,0x02,3,data);
 155         return self.data;
 156
 157     def SPIpokebyte(self,adr,val):
 158         self.SPIpokebytes(adr,[val]);
 159     def SPIpokebytes(self,adr,data):
 160         #self.SPIwriteenable();
 161         adranddata=[(adr&0xFF0000)>>16,
 162               (adr&0xFF00)>>8,
 163               adr&0xFF
 164               ]+data;
 165         self.writecmd(0x01,0x03,
 166                       len(adranddata),adranddata);
 167
 168     def SPIchiperase(self):
 169         """Mass erase an SPI Flash ROM."""
 170         self.writecmd(0x01,0x81,0,[]);
 171     def SPIwriteenable(self):
 172         """SPI Flash Write Enable"""
 173         data=[0x06];
 174         self.SPItrans(data);
 175
 176     def SPIjedecmanstr(self):
 177         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
 178         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer)
 179         if man==0:
 180             man="UNKNOWN";
 181         return man;
 182
 183     def SPIjedecstr(self):
 184         """Grab the JEDEC manufacturer string.  Call after SPIjedec()."""
 185         man=self.JEDECmanufacturers.get(self.JEDECmanufacturer);
 186         if man==0:
 187             man="UNKNOWN";
 188         device=self.JEDECdevices.get(self.JEDECdevice);
 189         if device==0:
 190             device="???"
 191         return "%s %s" % (man,device);
 192     def MSP430setup(self):
 193         """Move the FET into the MSP430 JTAG application."""
 194         print "Initializing MSP430.";
 195         self.writecmd(0x11,0x10,0,self.data);
 196
 197
 198
 199     def CCsetup(self):
 200         """Move the FET into the CC2430/CC2530 application."""
 201         print "Initializing Chipcon.";
 202         self.writecmd(0x30,0x10,0,self.data);
 203     def CCrd_config(self):
 204         """Read the config register of a Chipcon."""
 205         self.writecmd(0x30,0x82,0,self.data);
 206         return ord(self.data[0]);
 207     def CCwr_config(self,config):
 208         """Write the config register of a Chipcon."""
 209         self.writecmd(0x30,0x81,1,[config&0xFF]);
 210
 211     CCversions={0x0100:"CC1110",
 212                 0x8500:"CC2430",
 213                 0x8900:"CC2431",
 214                 0x8100:"CC2510",
 215                 0x9100:"CC2511",
 216                 0xFF00:"CCmissing"};
 217     def CCidentstr(self):
 218         ident=self.CCident();
 219         chip=self.CCversions[ident&0xFF00];
 220         return "%s/r%02x" % (chip, ident&0xFF);
 221     def CCident(self):
 222         """Get a chipcon's ID."""
 223         self.writecmd(0x30,0x8B,0,None);
 224         chip=ord(self.data[0]);
 225         rev=ord(self.data[1]);
 226         return (chip<<8)+rev;
 227     def CCgetPC(self):
 228         """Get a chipcon's PC."""
 229         self.writecmd(0x30,0x83,0,None);
 230         hi=ord(self.data[0]);
 231         lo=ord(self.data[1]);
 232         return (hi<<8)+lo;
 233     def CCdebuginstr(self,instr):
 234         self.writecmd(0x30,0x88,len(instr),instr);
 235         return ord(self.data[0]);
 236     def MSP430peek(self,adr):
 237         """Read the contents of memory at an address."""
 238         self.data=[adr&0xff, (adr&0xff00)>>8];
 239         self.writecmd(0x11,0x02,2,self.data);
 240         return ord(self.data[0])+(ord(self.data[1])<<8);
 241     def CCpeekcodebyte(self,adr):
 242         """Read the contents of code memory at an address."""
 243         self.data=[adr&0xff, (adr&0xff00)>>8];
 244         self.writecmd(0x30,0x90,2,self.data);
 245         return ord(self.data[0]);
 246     def CCpeekdatabyte(self,adr):
 247         """Read the contents of data memory at an address."""
 248         self.data=[adr&0xff, (adr&0xff00)>>8];
 249         self.writecmd(0x30,0x91, 2, self.data);
 250         return ord(self.data[0]);
 251     def CCpokedatabyte(self,adr,val):
 252         """Write a byte to data memory."""
 253         self.data=[adr&0xff, (adr&0xff00)>>8, val];
 254         self.writecmd(0x30, 0x92, 3, self.data);
 255         return ord(self.data[0]);
 256     def CCchiperase(self):
 257         """Erase all of the target's memory."""
 258         self.writecmd(0x30,0x80,0,None);
 259     def CCstatus(self):
 260         """Check the status."""
 261         self.writecmd(0x30,0x84,0,None);
 262         return ord(self.data[0])
 263     CCstatusbits={0x80 : "erased",
 264                   0x40 : "pcon_idle",
 265                   0x20 : "halted",
 266                   0x10 : "pm0",
 267                   0x08 : "halted",
 268                   0x04 : "locked",
 269                   0x02 : "oscstable",
 270                   0x01 : "overflow"};
 271     def CCstatusstr(self):
 272         """Check the status as a string."""
 273         status=self.CCstatus();
 274         str="";
 275         i=1;
 276         while i<0x100:
 277             if(status&i):
 278                 str="%s %s" %(self.CCstatusbits[i],str);
 279             i*=2;
 280         return str;
 281     def MSP430poke(self,adr,val):
 282         """Read the contents of memory at an address."""
 283         self.data=[adr&0xff, (adr&0xff00)>>8, val&0xff, (val&0xff00)>>8];
 284         self.writecmd(0x11,0x03,4,self.data);
 285         return;# ord(self.data[0])+(ord(self.data[1])<<8);
 286     def MSP430start(self):
 287         """Start debugging."""
 288         self.writecmd(0x11,0x20,0,self.data);
 289         ident=self.MSP430ident();
 290         print "Target identifies as %04x." % ident;
 291
 292     def CCstart(self):
 293         """Start debugging."""
 294         self.writecmd(0x30,0x20,0,self.data);
 295         ident=self.CCidentstr();
 296         print "Target identifies as %s." % ident;
 297         print "Status: %s." % self.CCstatusstr();
 298         self.CCreleasecpu();
 299         self.CChaltcpu();
 300         print "Status: %s." % self.CCstatusstr();
 301     def CCstop(self):
 302         """Stop debugging."""
 303         self.writecmd(0x30,0x21,0,self.data);
 304     def CCstep_instr(self):
 305         """Step one instruction."""
 306         self.writecmd(0x30,0x89,0,self.data);
 307     def MSP430stop(self):
 308         """Stop debugging."""
 309         self.writecmd(0x11,0x21,0,self.data);
 310     def MSP430haltcpu(self):
 311         """Halt the CPU."""
 312         self.writecmd(0x11,0xA0,0,self.data);
 313     def MSP430releasecpu(self):
 314         """Resume the CPU."""
 315         self.writecmd(0x11,0xA1,0,self.data);
 316     def CChaltcpu(self):
 317         """Halt the CPU."""
 318         self.writecmd(0x30,0x86,0,self.data);
 319     def CCreleasecpu(self):
 320         """Resume the CPU."""
 321         self.writecmd(0x30,0x87,0,self.data);
 322     def MSP430shiftir8(self,ins):
 323         """Shift the 8-bit Instruction Register."""
 324         data=[ins];
 325         self.writecmd(0x11,0x80,1,data);
 326         return ord(self.data[0]);
 327     def MSP430shiftdr16(self,dat):
 328         """Shift the 16-bit Data Register."""
 329         data=[dat&0xFF,(dat&0xFF00)>>8];
 330         self.writecmd(0x11,0x81,2,data);
 331         return ord(self.data[0])#+(ord(self.data[1])<<8);
 332     def MSP430setinstrfetch(self):
 333         """Set the instruction fetch mode."""
 334         self.writecmd(0x11,0xC1,0,self.data);
 335         return self.data[0];
 336     def MSP430ident(self):
 337         """Grab self-identification word from 0x0FF0 as big endian."""
 338         i=self.MSP430peek(0x0ff0);
 339         return ((i&0xFF00)>>8)+((i&0xFF)<<8)
 340     def MSP430test(self):
 341         """Test MSP430 JTAG.  Requires that a chip be attached."""
 342         if self.MSP430ident()==0xffff:
 343             print "Is anything connected?";
 344         print "Testing RAM.";
 345         temp=self.MSP430peek(0x0200);
 346         self.MSP430poke(0x0200,0xdead);
 347         if(self.MSP430peek(0x0200)!=0xdead):
 348             print "Poke of 0x0200 did not set to 0xDEAD properly.";
 349             return;
 350         self.MSP430poke(0x0200,temp); #restore old value.
 351     def MSP430flashtest(self):
 352         self.MSP430masserase();
 353         i=0x2500;
 354         while(i<0xFFFF):
 355             if(self.MSP430peek(i)!=0xFFFF):
 356                 print "ERROR: Unerased flash at %04x."%i;
 357             self.MSP430writeflash(i,0xDEAD);
 358             i+=2;
 359     def MSP430masserase(self):
 360         """Erase MSP430 flash memory."""
 361         self.writecmd(0x11,0xE3,0,None);
 362     def MSP430writeflash(self,adr,val):
 363         """Write a word of flash memory."""
 364         if(self.MSP430peek(adr)!=0xFFFF):
 365             print "FLASH ERROR: %04x not clear." % adr;
 366         data=[adr&0xFF,(adr&0xFF00)>>8,val&0xFF,(val&0xFF00)>>8];
 367         self.writecmd(0x11,0xE1,4,data);
 368         rval=ord(self.data[0])+(ord(self.data[1])<<8);
 369         if(val!=rval):
 370             print "FLASH WRITE ERROR AT %04x.  Found %04x, wrote %04x." % (adr,rval,val);
 371
 372     def MSP430dumpbsl(self):
 373         self.MSP430dumpmem(0xC00,0xfff);
 374     def MSP430dumpallmem(self):
 375         self.MSP430dumpmem(0x200,0xffff);
 376     def MSP430dumpmem(self,begin,end):
 377         i=begin;
 378         while i<end:
 379             print "%04x %04x" % (i, self.MSP430peek(i));
 380             i+=2;
 381     def CCtest(self):
 382         self.CCreleasecpu();
 383         self.CChaltcpu();
 384         print "Status: %s" % self.CCstatusstr();
 385
 386         #Grab ident three times, should be equal.
 387         ident1=self.CCident();
 388         ident2=self.CCident();
 389         ident3=self.CCident();
 390         if(ident1!=ident2 or ident2!=ident3):
 391             print "Error, repeated ident attempts unequal."
 392             print "%04x, %04x, %04x" % (ident1, ident2, ident3);
 393
 394         #Single step, printing PC.
 395         #print "Tracing execution at startup."
 396         for i in range(1,15):
 397             pc=self.CCgetPC();
 398             byte=self.CCpeekcodebyte(i);
 399             print "PC=%04x, %02x" % (pc, byte);
 400             self.CCstep_instr();
 401
 402         #print "Verifying that debugging a NOP doesn't affect the PC."
 403         for i in range(1,15):
 404             pc=self.CCgetPC();
 405             self.CCdebuginstr([0x00]);
 406             if(pc!=self.CCgetPC()):
 407                 print "ERROR: PC changed during CCdebuginstr([NOP])!";
 408         for i in range(0xE500,0xE600):
 409             byte=self.CCpeekdatabyte(i);
 410             print "data %04x: %02x" % (i,byte);
 411             self.CCpokedatabyte(i,i&0xFF);
 412             byte=self.CCpeekdatabyte(i);
 413             print "data %04x: %02x" % (i,byte);
 414         print "Status: %s." % self.CCstatusstr();
 415         #Exit debugger
 416         self.CCstop();
 417         print "Done.";