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 being rewritten and refactored.  You've been warned!
   7
   8 import sys, time, string, cStringIO, struct, glob, serial, os;
   9
  10
  11 class GoodFET:
  12     """GoodFET Client Library"""
  13
  14     GLITCHAPP=0x71;
  15
  16     def __init__(self, *args, **kargs):
  17         self.data=[0];
  18     def timeout(self):
  19         print "timeout\n";
  20     def serInit(self, port=None):
  21         """Open the serial port"""
  22
  23         if port is None and os.environ.get("GOODFET")!=None:
  24             glob_list = glob.glob(os.environ.get("GOODFET"));
  25             if len(glob_list) > 0:
  26                 port = glob_list[0];
  27         if port is None:
  28             glob_list = glob.glob("/dev/tty.usbserial*");
  29             if len(glob_list) > 0:
  30                 port = glob_list[0];
  31         if port is None:
  32             glob_list = glob.glob("/dev/ttyUSB*");
  33             if len(glob_list) > 0:
  34                 port = glob_list[0];
  35
  36         self.serialport = serial.Serial(
  37             port,
  38             #9600,
  39             115200,
  40             parity = serial.PARITY_NONE
  41             )
  42
  43         #This might cause problems, but it makes failure graceful.
  44         #self.serialport._timeout = 5;
  45
  46         #Explicitly set RTS and DTR to halt board.
  47         self.serialport.setRTS(1);
  48         self.serialport.setDTR(1);
  49         #Drop DTR, which is !RST, low to begin the app.
  50         self.serialport.setDTR(0);
  51         self.serialport.flushInput()
  52         self.serialport.flushOutput()
  53
  54         #Read and handle the initial command.
  55         #time.sleep(1);
  56         self.readcmd(); #Read the first command.
  57         if(self.verb!=0x7F):
  58             print "Verb %02x is wrong.  Incorrect firmware?" % self.verb;
  59         #print "Connected."
  60     def getbuffer(self,size=0x1c00):
  61         writecmd(0,0xC2,[size&0xFF,(size>>16)&0xFF]);
  62         print "Got %02x%02x buffer size." % (self.data[1],self.data[0]);
  63     def writecmd(self, app, verb, count=0, data=[]):
  64         """Write a command and some data to the GoodFET."""
  65         self.serialport.write(chr(app));
  66         self.serialport.write(chr(verb));
  67
  68         #if data!=None:
  69         #    count=len(data); #Initial count ignored.
  70
  71         #print "TX %02x %02x" % (app,verb);
  72
  73         #little endian 16-bit length
  74         self.serialport.write(chr(count&0xFF));
  75         self.serialport.write(chr(count>>8));
  76
  77         #print "count=%02x, len(data)=%04x" % (count,len(data));
  78
  79         if count!=0:
  80             for i in range(0,count):
  81                 #print "Converting %02x at %i" % (data[i],i)
  82                 data[i]=chr(data[i]);
  83             outstr=''.join(data);
  84             #outstr=data;
  85             self.serialport.write(outstr);
  86         if not self.besilent:
  87             self.readcmd();
  88
  89     besilent=0;
  90     app=0;
  91     verb=0;
  92     count=0;
  93     data="";
  94
  95     def readcmd(self):
  96         """Read a reply from the GoodFET."""
  97         while 1:
  98             #print "Reading...";
  99             self.app=ord(self.serialport.read(1));
 100             #print "APP=%2x" % self.app;
 101             self.verb=ord(self.serialport.read(1));
 102             #print "VERB=%02x" % self.verb;
 103             self.count=(
 104                 ord(self.serialport.read(1))
 105                 +(ord(self.serialport.read(1))<<8)
 106                 );
 107
 108             #Debugging string; print, but wait.
 109             if self.app==0xFF and self.verb==0xFF:
 110                 print "# DEBUG %s" % self.serialport.read(self.count);
 111             else:
 112                 self.data=self.serialport.read(self.count);
 113                 return self.data;
 114     #Glitching stuff.
 115     def glitchAPP(self,app):
 116         """Glitch into a device by its application."""
 117         self.data=[app&0xff];
 118         self.writecmd(self.GLITCHAPP,0x80,1,self.data);
 119         #return ord(self.data[0]);
 120     def glitchVERB(self,app,verb, data):
 121         """Glitch during a transaction.."""
 122         self.data=[app&0xff, verb&0xFF]+data;
 123         self.writecmd(self.GLITCHAPP,0x81,len(self.data),self.data);
 124         #return ord(self.data[0]);
 125     def glitchVoltages(self,low=0x0880, high=0x0fff):
 126         """Set glitching voltages. (0x0fff is max.)"""
 127         self.data=[low&0xff, (low>>8)&0xff,
 128                    high&0xff, (high>>8)&0xff];
 129         self.writecmd(self.GLITCHAPP,0x90,4,self.data);
 130         #return ord(self.data[0]);
 131     def glitchRate(self,count=0x0800):
 132         """Set glitching count period."""
 133         self.data=[count&0xff, (count>>8)&0xff];
 134         self.writecmd(self.GLITCHAPP,0x91,2,
 135                       self.data);
 136         #return ord(self.data[0]);
 137
 138
 139     #Monitor stuff
 140     def silent(self,s=0):
 141         """Transmissions halted when 1."""
 142         self.besilent=s;
 143         print "besilent is %i" % self.besilent;
 144         self.writecmd(0,0xB0,1,[s]);
 145
 146     def out(self,byte):
 147         """Write a byte to P5OUT."""
 148         self.writecmd(0,0xA1,1,[byte]);
 149     def dir(self,byte):
 150         """Write a byte to P5DIR."""
 151         self.writecmd(0,0xA0,1,[byte]);
 152     def peekbyte(self,address):
 153         """Read a byte of memory from the monitor."""
 154         self.data=[address&0xff,address>>8];
 155         self.writecmd(0,0x02,2,self.data);
 156         #self.readcmd();
 157         return ord(self.data[0]);
 158     def peekword(self,address):
 159         """Read a word of memory from the monitor."""
 160         return self.peekbyte(address)+(self.peekbyte(address+1)<<8);
 161     def pokebyte(self,address,value):
 162         """Set a byte of memory by the monitor."""
 163         self.data=[address&0xff,address>>8,value];
 164         self.writecmd(0,0x03,3,self.data);
 165         return ord(self.data[0]);
 166     def dumpmem(self,begin,end):
 167         i=begin;
 168         while i<end:
 169             print "%04x %04x" % (i, self.peekword(i));
 170             i+=2;
 171     def monitor_ram_pattern(self):
 172         """Overwrite all of RAM with 0xBEEF."""
 173         self.writecmd(0,0x90,0,self.data);
 174         return;
 175     def monitor_ram_depth(self):
 176         """Determine how many bytes of RAM are unused by looking for 0xBEEF.."""
 177         self.writecmd(0,0x91,0,self.data);
 178         return ord(self.data[0])+(ord(self.data[1])<<8);
 179
 180     #Baud rates.
 181     baudrates=[115200,
 182                9600,
 183                19200,
 184                38400,
 185                57600,
 186                115200];
 187     def setBaud(self,baud):
 188         """Change the baud rate.  TODO fix this."""
 189         rates=self.baudrates;
 190         self.data=[baud];
 191         print "Changing FET baud."
 192         self.serialport.write(chr(0x00));
 193         self.serialport.write(chr(0x80));
 194         self.serialport.write(chr(1));
 195         self.serialport.write(chr(baud));
 196
 197         print "Changed host baud."
 198         self.serialport.setBaudrate(rates[baud]);
 199         time.sleep(1);
 200         self.serialport.flushInput()
 201         self.serialport.flushOutput()
 202
 203         print "Baud is now %i." % rates[baud];
 204         return;
 205     def readbyte(self):
 206         return ord(self.serialport.read(1));
 207     def findbaud(self):
 208         for r in self.baudrates:
 209             print "\nTrying %i" % r;
 210             self.serialport.setBaudrate(r);
 211             #time.sleep(1);
 212             self.serialport.flushInput()
 213             self.serialport.flushOutput()
 214
 215             for i in range(1,10):
 216                 self.readbyte();
 217
 218             print "Read %02x %02x %02x %02x" % (
 219                 self.readbyte(),self.readbyte(),self.readbyte(),self.readbyte());
 220     def monitortest(self):
 221         """Self-test several functions through the monitor."""
 222         print "Performing monitor self-test.";
 223
 224         if self.peekword(0x0c00)!=0x0c04 and self.peekword(0x0c00)!=0x0c06:
 225             print "ERROR Fetched wrong value from 0x0c04.";
 226         self.pokebyte(0x0021,0); #Drop LED
 227         if self.peekbyte(0x0021)!=0:
 228             print "ERROR, P1OUT not cleared.";
 229         self.pokebyte(0x0021,1); #Light LED
 230
 231         print "Self-test complete.";
 232
 233
 234
 235     def I2Csetup(self):
 236         """Move the FET into the I2C application."""
 237         self.writecmd(0x02,0x10,0,self.data); #SPI/SETUP
 238     def I2Cstart(self):
 239         """Start an I2C transaction."""
 240         self.writecmd(0x02,0x20,0,self.data); #SPI/SETUP
 241     def I2Cstop(self):
 242         """Stop an I2C transaction."""
 243         self.writecmd(0x02,0x21,0,self.data); #SPI/SETUP
 244     def I2Cread(self,len=1):
 245         """Read len bytes by I2C."""
 246         self.writecmd(0x02,0x00,1,[len]); #SPI/SETUP
 247         return self.data;
 248     def I2Cwrite(self,bytes):
 249         """Write bytes by I2C."""
 250         self.writecmd(0x02,0x01,len(bytes),bytes); #SPI/SETUP
 251         return ord(self.data[0]);