The STM32 UART is finally running.
[goodfet] / 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, os;
9 import sqlite3;
10
11 fmt = ("B", "<H", None, "<L")
12
13 def getClient(name="GoodFET"):
14     import GoodFET, GoodFETCC, GoodFETAVR, GoodFETSPI, GoodFETMSP430, GoodFETNRF, GoodFETCCSPI;
15     if(name=="GoodFET" or name=="monitor"): return GoodFET.GoodFET();
16     elif name=="cc" or name=="cc51": return GoodFETCC.GoodFETCC();
17     elif name=="cc2420" or name=="ccspi": return GoodFETCCSPI.GoodFETCCSPI();
18     elif name=="avr": return GoodFETAVR.GoodFETAVR();
19     elif name=="spi": return GoodFETSPI.GoodFETSPI();
20     elif name=="msp430": return GoodFETMSP430.GoodFETMSP430();
21     elif name=="nrf": return GoodFETNRF.GoodFETNRF();
22     
23     print "Unsupported target: %s" % name;
24     sys.exit(0);
25
26 class SymbolTable:
27     """GoodFET Symbol Table"""
28     db=sqlite3.connect(":memory:");
29     
30     def __init__(self, *args, **kargs):
31         self.db.execute("create table if not exists symbols(adr,name,memory,size,comment);");
32     def get(self,name):
33         self.db.commit();
34         c=self.db.cursor();
35         try:
36             c.execute("select adr,memory from symbols where name=?",(name,));
37             for row in c:
38                 #print "Found it.";
39                 sys.stdout.flush();
40                 return row[0];
41             #print "No dice.";
42         except:# sqlite3.OperationalError:
43             #print "SQL error.";
44             return eval(name);
45         return eval(name);
46     def define(self,adr,name,comment="",memory="vn",size=16):
47         self.db.execute("insert into symbols(adr,name,memory,size,comment)"
48                         "values(?,?,?,?,?);", (
49                 adr,name,memory,size,comment));
50         #print "Set %s=%s." % (name,adr);
51 class GoodFETbtser:
52     """py-bluez class for emulating py-serial."""
53     def __init__(self,btaddr):
54         import bluetooth;
55         if btaddr==None or btaddr=="none" or btaddr=="bluetooth":
56             print "performing inquiry..."
57             nearby_devices = bluetooth.discover_devices(lookup_names = True)
58             print "found %d devices" % len(nearby_devices)
59             for addr, name in nearby_devices:
60                 print "  %s - '%s'" % (addr, name)
61                 #TODO switch to wildcards.
62                 if name=='FireFly-A6BD':
63                     btaddr=addr;
64                 if name=='RN42-A94A':
65                     btaddr=addr;
66                 
67             print "Please set $GOODFET to the address of your device.";
68             sys.exit();
69         print "Identified GoodFET at %s" % btaddr;
70
71         # Manually use the portnumber.
72         port=1;
73         
74         print "Connecting to %s on port %i." % (btaddr, port);
75         sock=bluetooth.BluetoothSocket(bluetooth.RFCOMM);
76         self.sock=sock;
77         sock.connect((btaddr,port));
78         sock.settimeout(10);  #IMPORTANT Must be patient.
79         
80         ##This is what we'd do for a normal reset.
81         #str="";
82         #while not str.endswith("goodfet.sf.net/"):
83         #    str=self.read(64);
84         #    print str;
85         
86         # Instead, just return and hope for the best.
87         return;
88         
89     def write(self,msg):
90         """Send traffic."""
91         import time;
92         self.sock.send(msg);
93         #time.sleep(0.1);
94         return;
95     def read(self,length):
96         """Read traffic."""
97         data="";
98         while len(data)<length:
99             data=data+self.sock.recv(length-len(data));
100         return data;
101 class GoodFET:
102     """GoodFET Client Library"""
103
104     besilent=0;
105     app=0;
106     verb=0;
107     count=0;
108     data="";
109     verbose=False
110     
111     GLITCHAPP=0x71;
112     MONITORAPP=0x00;
113     symbols=SymbolTable();
114     
115     def __init__(self, *args, **kargs):
116         self.data=[0];
117     def getConsole(self):
118         from GoodFETConsole import GoodFETConsole;
119         return GoodFETConsole(self);
120     def name2adr(self,name):
121         return self.symbols.get(name);
122     def timeout(self):
123         print "timeout\n";
124     def serInit(self, port=None, timeout=2, attemptlimit=None):
125         """Open a serial port of some kind."""
126         import re;
127         
128         if port==None:
129             port=os.environ.get("GOODFET");
130         if port=="bluetooth" or (port is not None and re.match("..:..:..:..:..:..",port)):
131             self.btInit(port,timeout,attemptlimit);
132         else:
133             self.pyserInit(port,timeout,attemptlimit);
134     def btInit(self, port, timeout, attemptlimit):
135         """Open a bluetooth port.""";
136         #self.verbose=True;  #For debugging BT.
137         self.serialport=GoodFETbtser(port);
138         
139     def pyserInit(self, port, timeout, attemptlimit):
140         """Open the serial port"""
141         # Make timeout None to wait forever, 0 for non-blocking mode.
142         import serial;
143         
144         if os.name=='nt' and sys.version.find('64 bit')!=-1:
145             print "WARNING: PySerial requires a 32-bit Python build in Windows.";
146         
147         if port is None and os.environ.get("GOODFET")!=None:
148             glob_list = glob.glob(os.environ.get("GOODFET"));
149             if len(glob_list) > 0:
150                 port = glob_list[0];
151             else:
152                 port = os.environ.get("GOODFET");
153         if port is None:
154             glob_list = glob.glob("/dev/tty.usbserial*");
155             if len(glob_list) > 0:
156                 port = glob_list[0];
157         if port is None:
158             glob_list = glob.glob("/dev/ttyUSB*");
159             if len(glob_list) > 0:
160                 port = glob_list[0];
161         if port is None:
162             glob_list = glob.glob("/dev/ttyU0");
163             if len(glob_list) > 0:
164                 port = glob_list[0];
165         if port is None and os.name=='nt':
166             from scanwin32 import winScan;
167             scan=winScan();
168             for order,comport,desc,hwid in sorted(scan.comports()):
169                 try:
170                     if hwid.index('FTDI')==0:
171                         port=comport;
172                         #print "Using FTDI port %s" % port
173                 except:
174                     #Do nothing.
175                     a=1;
176         
177         baud=115200;
178         if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
179             baud=19200; #Slower, for now.
180         self.serialport = serial.Serial(
181             port,
182             #9600,
183             baud,
184             parity = serial.PARITY_NONE,
185             timeout=timeout
186             )
187         
188         self.verb=0;
189         attempts=0;
190         connected=0;
191         while connected==0:
192             while self.verb!=0x7F or self.data!="http://goodfet.sf.net/":
193             #while self.data!="http://goodfet.sf.net/":
194                 #print "'%s'!=\n'%s'" % (self.data,"http://goodfet.sf.net/");
195                 if attemptlimit is not None and attempts >= attemptlimit:
196                     return
197                 elif attempts>2:
198                     print "Resyncing.";
199                 self.serialport.flushInput()
200                 self.serialport.flushOutput()
201                 
202                 #TelosB reset, prefer software to I2C SPST Switch.
203                 if (os.environ.get("platform")=='telosb' or  os.environ.get("board")=='telosb'):
204                     #print "TelosB Reset";
205                     self.telosBReset();
206                 elif (os.environ.get("board")=='zolertiaz1' or  os.environ.get("board")=='z1'):
207                     self.bslResetZ1();
208                 else:
209                     #Explicitly set RTS and DTR to halt board.
210                     self.serialport.setRTS(1);
211                     self.serialport.setDTR(1);
212                     #Drop DTR, which is !RST, low to begin the app.
213                     self.serialport.setDTR(0);
214                 
215                 #self.serialport.write(chr(0x80));
216                 #self.serialport.write(chr(0x80));
217                 #self.serialport.write(chr(0x80));
218                 #self.serialport.write(chr(0x80));
219                 
220                 
221                 #self.serialport.flushInput()
222                 #self.serialport.flushOutput()
223                 #time.sleep(60);
224                 attempts=attempts+1;
225                 self.readcmd(); #Read the first command.
226                 #print "Got %02x,%02x:'%s'" % (self.app,self.verb,self.data);
227             #Here we have a connection, but maybe not a good one.
228             #print "We have a connection."
229             connected=1;
230             olds=self.infostring();
231             clocking=self.monitorclocking();
232             for foo in range(1,30):
233                 if not self.monitorecho():
234                     if self.verbose:
235                         print "Comm error on %i try, resyncing out of %s." % (foo,
236                                                                               clocking);
237                         connected=0;
238                         break;
239         if self.verbose: print "Connected after %02i attempts." % attempts;
240         self.mon_connected();
241         self.serialport.setTimeout(12);
242     def serClose(self):
243         self.serialport.close();
244     def telosSetSCL(self, level):
245         self.serialport.setRTS(not level)
246     def telosSetSDA(self, level):
247         self.serialport.setDTR(not level)
248
249     def telosI2CStart(self):
250         self.telosSetSDA(1)
251         self.telosSetSCL(1)
252         self.telosSetSDA(0)
253
254     def telosI2CStop(self):
255         self.telosSetSDA(0)
256         self.telosSetSCL(1)
257         self.telosSetSDA(1)
258
259     def telosI2CWriteBit(self, bit):
260         self.telosSetSCL(0)
261         self.telosSetSDA(bit)
262         time.sleep(2e-6)
263         self.telosSetSCL(1)
264         time.sleep(1e-6)
265         self.telosSetSCL(0)
266
267     def telosI2CWriteByte(self, byte):
268         self.telosI2CWriteBit( byte & 0x80 );
269         self.telosI2CWriteBit( byte & 0x40 );
270         self.telosI2CWriteBit( byte & 0x20 );
271         self.telosI2CWriteBit( byte & 0x10 );
272         self.telosI2CWriteBit( byte & 0x08 );
273         self.telosI2CWriteBit( byte & 0x04 );
274         self.telosI2CWriteBit( byte & 0x02 );
275         self.telosI2CWriteBit( byte & 0x01 );
276         self.telosI2CWriteBit( 0 );  # "acknowledge"
277
278     def telosI2CWriteCmd(self, addr, cmdbyte):
279         self.telosI2CStart()
280         self.telosI2CWriteByte( 0x90 | (addr << 1) )
281         self.telosI2CWriteByte( cmdbyte )
282         self.telosI2CStop()
283     def bslResetZ1(self, invokeBSL=0):
284         '''
285         Applies BSL entry sequence on RST/NMI and TEST/VPP pins
286         Parameters:
287             invokeBSL = 1: complete sequence
288             invokeBSL = 0: only RST/NMI pin accessed
289             
290         By now only BSL mode is accessed
291         '''
292         
293         #if DEBUG > 1: sys.stderr.write("* bslReset(invokeBSL=%s)\n" % invokeBSL)
294         if invokeBSL:
295             #sys.stderr.write("in Z1 bsl reset...\n")
296             time.sleep(0.1)
297             self.writepicROM(0xFF, 0xFF)
298             time.sleep(0.1)
299             #sys.stderr.write("z1 bsl reset done...\n")
300         else:
301             #sys.stderr.write("in Z1 reset...\n")
302             time.sleep(0.1)
303             self.writepicROM(0xFF, 0xFE)
304             time.sleep(0.1)
305             #sys.stderr.write("z1 reset done...\n")
306     def writepicROM(self, address, data):
307         ''' Writes data to @address'''
308         for i in range(7,-1,-1):
309             self.picROMclock((address >> i) & 0x01)
310         self.picROMclock(0)
311         recbuf = 0
312         for i in range(7,-1,-1):
313             s = ((data >> i) & 0x01)
314             #print s
315             if i < 1:
316                 r = not self.picROMclock(s, True)
317             else:
318                 r = not self.picROMclock(s)
319             recbuf = (recbuf << 1) + r
320
321         self.picROMclock(0, True)
322         #k = 1
323         #while not self.serial.getCTS():
324         #    pass 
325         #time.sleep(0.1)
326         return recbuf
327     def readpicROM(self, address):
328         ''' reads a byte from @address'''
329         for i in range(7,-1,-1):
330             self.picROMclock((address >> i) & 0x01)
331         self.picROMclock(1)
332         recbuf = 0
333         r = 0
334         for i in range(7,-1,-1):
335             r = self.picROMclock(0)
336             recbuf = (recbuf << 1) + r
337         self.picROMclock(r)
338         #time.sleep(0.1)
339         return recbuf
340         
341     def picROMclock(self, masterout, slow = False):
342         #print "setting masterout to "+str(masterout)
343         self.serialport.setRTS(masterout)
344         self.serialport.setDTR(1)
345         #time.sleep(0.02)
346         self.serialport.setDTR(0)
347         if slow:
348             time.sleep(0.02)
349         return self.serialport.getCTS()
350
351     def picROMfastclock(self, masterout):
352         #print "setting masterout to "+str(masterout)
353         self.serialport.setRTS(masterout)
354         self.serialport.setDTR(1)
355         self.serialport.setDTR(0)
356         time.sleep(0.02)
357         return self.serialport.getCTS()
358
359     def telosBReset(self,invokeBSL=0):
360         # "BSL entry sequence at dedicated JTAG pins"
361         # rst !s0: 0 0 0 0 1 1
362         # tck !s1: 1 0 1 0 0 1
363         #   s0|s1: 1 3 1 3 2 0
364
365         # "BSL entry sequence at shared JTAG pins"
366         # rst !s0: 0 0 0 0 1 1
367         # tck !s1: 0 1 0 1 1 0
368         #   s0|s1: 3 1 3 1 0 2
369
370         if invokeBSL:
371             self.telosI2CWriteCmd(0,1)
372             self.telosI2CWriteCmd(0,3)
373             self.telosI2CWriteCmd(0,1)
374             self.telosI2CWriteCmd(0,3)
375             self.telosI2CWriteCmd(0,2)
376             self.telosI2CWriteCmd(0,0)
377         else:
378             self.telosI2CWriteCmd(0,3)
379             self.telosI2CWriteCmd(0,2)
380
381         # This line was not defined inside the else: block, not sure where it
382         # should be however
383         self.telosI2CWriteCmd(0,0)
384         time.sleep(0.250)       #give MSP430's oscillator time to stabilize
385         self.serialport.flushInput()  #clear buffers
386
387
388     def getbuffer(self,size=0x1c00):
389         writecmd(0,0xC2,[size&0xFF,(size>>16)&0xFF]);
390         print "Got %02x%02x buffer size." % (self.data[1],self.data[0]);
391     def writecmd(self, app, verb, count=0, data=[]):
392         """Write a command and some data to the GoodFET."""
393         self.serialport.write(chr(app));
394         self.serialport.write(chr(verb));
395         
396         #if data!=None:
397         #    count=len(data); #Initial count ignored.
398         
399         #print "TX %02x %02x %04x" % (app,verb,count);
400         
401         #little endian 16-bit length
402         self.serialport.write(chr(count&0xFF));
403         self.serialport.write(chr(count>>8));
404
405         if self.verbose:
406             print "Tx: ( 0x%02x, 0x%02x, 0x%04x )" % ( app, verb, count )
407         
408         #print "count=%02x, len(data)=%04x" % (count,len(data));
409         
410         if count!=0:
411             if(isinstance(data,list)):
412                 for i in range(0,count):
413                 #print "Converting %02x at %i" % (data[i],i)
414                     data[i]=chr(data[i]);
415             #print type(data);
416             outstr=''.join(data);
417             self.serialport.write(outstr);
418         if not self.besilent:
419             return self.readcmd()
420         else:
421             return []
422
423     def readcmd(self):
424         """Read a reply from the GoodFET."""
425         while 1:#self.serialport.inWaiting(): # Loop while input data is available
426             try:
427                 #print "Reading...";
428                 self.app=ord(self.serialport.read(1));
429                 #print "APP=%02x" % self.app;
430                 self.verb=ord(self.serialport.read(1));
431                 
432                 #Fixes an obscure bug in the TelosB.
433                 if self.app==0x00:
434                     while self.verb==0x00:
435                         self.verb=ord(self.serialport.read(1));
436                 
437                 #print "VERB=%02x" % self.verb;
438                 self.count=(
439                     ord(self.serialport.read(1))
440                     +(ord(self.serialport.read(1))<<8)
441                     );
442
443                 if self.verbose:
444                     print "Rx: ( 0x%02x, 0x%02x, 0x%04x )" % ( self.app, self.verb, self.count )
445             
446                 #Debugging string; print, but wait.
447                 if self.app==0xFF:
448                     if self.verb==0xFF:
449                         print "# DEBUG %s" % self.serialport.read(self.count)
450                     elif self.verb==0xFE:
451                         print "# DEBUG 0x%x" % struct.unpack(fmt[self.count-1], self.serialport.read(self.count))[0]
452                     elif self.verb==0xFD:
453                         #Do nothing, just wait so there's no timeout.
454                         print "# NOP.";
455                         
456                     sys.stdout.flush();
457                 else:
458                     self.data=self.serialport.read(self.count);
459                     return self.data;
460             except TypeError:
461                 if self.connected:
462                     print "Warning: waiting for serial read timed out (most likely).";
463                     #print "This shouldn't happen after syncing.  Exiting for safety.";                    
464                     #sys.exit(-1)
465                 return self.data;
466     #Glitching stuff.
467     def glitchApp(self,app):
468         """Glitch into a device by its application."""
469         self.data=[app&0xff];
470         self.writecmd(self.GLITCHAPP,0x80,1,self.data);
471         #return ord(self.data[0]);
472     def glitchVerb(self,app,verb,data):
473         """Glitch during a transaction."""
474         if data==None: data=[];
475         self.data=[app&0xff, verb&0xFF]+data;
476         self.writecmd(self.GLITCHAPP,0x81,len(self.data),self.data);
477         #return ord(self.data[0]);
478     def glitchstart(self):
479         """Glitch into the AVR application."""
480         self.glitchVerb(self.APP,0x20,None);
481     def glitchstarttime(self):
482         """Measure the timer of the START verb."""
483         return self.glitchTime(self.APP,0x20,None);
484     def glitchTime(self,app,verb,data):
485         """Time the execution of a verb."""
486         if data==None: data=[];
487         self.data=[app&0xff, verb&0xFF]+data;
488         print "Timing app %02x verb %02x." % (app,verb);
489         self.writecmd(self.GLITCHAPP,0x82,len(self.data),self.data);
490         time=ord(self.data[0])+(ord(self.data[1])<<8);
491         print "Timed to be %i." % time;
492         return time;
493     def glitchVoltages(self,low=0x0880, high=0x0fff):
494         """Set glitching voltages. (0x0fff is max.)"""
495         self.data=[low&0xff, (low>>8)&0xff,
496                    high&0xff, (high>>8)&0xff];
497         self.writecmd(self.GLITCHAPP,0x90,4,self.data);
498         #return ord(self.data[0]);
499     def glitchRate(self,count=0x0800):
500         """Set glitching count period."""
501         self.data=[count&0xff, (count>>8)&0xff];
502         self.writecmd(self.GLITCHAPP,0x91,2,
503                       self.data);
504         #return ord(self.data[0]);
505     
506     
507     #Monitor stuff
508     def silent(self,s=0):
509         """Transmissions halted when 1."""
510         self.besilent=s;
511         print "besilent is %i" % self.besilent;
512         self.writecmd(0,0xB0,1,[s]);
513     connected=0;
514     def mon_connected(self):
515         """Announce to the monitor that the connection is good."""
516         self.connected=1;
517         self.writecmd(0,0xB1,0,[]);
518     def out(self,byte):
519         """Write a byte to P5OUT."""
520         self.writecmd(0,0xA1,1,[byte]);
521     def dir(self,byte):
522         """Write a byte to P5DIR."""
523         self.writecmd(0,0xA0,1,[byte]);
524     def call(self,adr):
525         """Call to an address."""
526         self.writecmd(0,0x30,2,
527                       [adr&0xFF,(adr>>8)&0xFF]);
528     def execute(self,code):
529         """Execute supplied code."""
530         self.writecmd(0,0x31,2,#len(code),
531                       code);
532     def MONpeek8(self,address):
533         """Read a byte of memory from the monitor."""
534         self.data=[address&0xff,address>>8];
535         self.writecmd(0,0x02,2,self.data);
536         #self.readcmd();
537         return ord(self.data[0]);
538     def MONpeek16(self,address):
539         """Read a word of memory from the monitor."""
540         return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
541     def peek(self,address):
542         """Read a word of memory from the monitor."""
543         return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
544     def eeprompeek(self,address):
545         """Read a word of memory from the monitor."""
546         print "EEPROM peeking not supported for the monitor.";
547         #return self.MONpeek8(address)+(self.MONpeek8(address+1)<<8);
548     def peekbysym(self,name):
549         """Read a value by its symbol name."""
550         #TODO include memory in symbol.
551         reg=self.symbols.get(name);
552         return self.peek8(reg,"data");
553     def pokebysym(self,name,val):
554         """Write a value by its symbol name."""
555         #TODO include memory in symbol.
556         reg=self.symbols.get(name);
557         return self.pokebyte(reg,val);
558     def pokebyte(self,address,value,memory="vn"):
559         """Set a byte of memory by the monitor."""
560         self.data=[address&0xff,address>>8,value];
561         self.writecmd(0,0x03,3,self.data);
562         return ord(self.data[0]);
563     def poke16(self,address,value):
564         """Set a word of memory by the monitor."""
565         self.pokebyte(address,value&0xFF);
566         self.pokebyte(address,(value>>8)&0xFF);
567         return value;
568     def setsecret(self,value):
569         """Set a secret word for later retreival.  Used by glitcher."""
570         #self.eeprompoke(0,value);
571         #self.eeprompoke(1,value);
572         print "Secret setting is not yet suppored for this target.";
573         print "Aborting.";
574         
575     def getsecret(self):
576         """Get a secret word.  Used by glitcher."""
577         #self.eeprompeek(0);
578         print "Secret getting is not yet suppored for this target.";
579         print "Aborting.";
580         sys.exit();
581     
582     def dumpmem(self,begin,end):
583         i=begin;
584         while i<end:
585             print "%04x %04x" % (i, self.MONpeek16(i));
586             i+=2;
587     def monitor_ram_pattern(self):
588         """Overwrite all of RAM with 0xBEEF."""
589         self.writecmd(0,0x90,0,self.data);
590         return;
591     def monitor_ram_depth(self):
592         """Determine how many bytes of RAM are unused by looking for 0xBEEF.."""
593         self.writecmd(0,0x91,0,self.data);
594         return ord(self.data[0])+(ord(self.data[1])<<8);
595     
596     #Baud rates.
597     baudrates=[115200, 
598                9600,
599                19200,
600                38400,
601                57600,
602                115200];
603     def setBaud(self,baud):
604         """Change the baud rate.  TODO fix this."""
605         rates=self.baudrates;
606         self.data=[baud];
607         print "Changing FET baud."
608         self.serialport.write(chr(0x00));
609         self.serialport.write(chr(0x80));
610         self.serialport.write(chr(1));
611         self.serialport.write(chr(baud));
612         
613         print "Changed host baud."
614         self.serialport.setBaudrate(rates[baud]);
615         time.sleep(1);
616         self.serialport.flushInput()
617         self.serialport.flushOutput()
618         
619         print "Baud is now %i." % rates[baud];
620         return;
621     def readbyte(self):
622         return ord(self.serialport.read(1));
623     def findbaud(self):
624         for r in self.baudrates:
625             print "\nTrying %i" % r;
626             self.serialport.setBaudrate(r);
627             #time.sleep(1);
628             self.serialport.flushInput()
629             self.serialport.flushOutput()
630             
631             for i in range(1,10):
632                 self.readbyte();
633             
634             print "Read %02x %02x %02x %02x" % (
635                 self.readbyte(),self.readbyte(),self.readbyte(),self.readbyte());
636     def monitortest(self):
637         """Self-test several functions through the monitor."""
638         print "Performing monitor self-test.";
639         self.monitorclocking();
640         for f in range(0,3000):
641             a=self.MONpeek16(0x0c00);
642             b=self.MONpeek16(0x0c02);
643             if a!=0x0c04 and a!=0x0c06:
644                 print "ERROR Fetched %04x, %04x" % (a,b);
645             self.pokebyte(0x0021,0); #Drop LED
646             if self.MONpeek8(0x0021)!=0:
647                 print "ERROR, P1OUT not cleared.";
648             self.pokebyte(0x0021,1); #Light LED
649             if not self.monitorecho():
650                 print "Echo test failed.";
651         print "Self-test complete.";
652         self.monitorclocking();
653     def monitorecho(self):
654         data="The quick brown fox jumped over the lazy dog.";
655         self.writecmd(self.MONITORAPP,0x81,len(data),data);
656         if self.data!=data:
657             print "Comm error recognized by monitorecho(), got:\n%s" % self.data;
658             return 0;
659         return 1;
660
661     def monitor_info(self):
662         print "GoodFET with %s MCU" % self.infostring();
663         print "Clocked at %s" % self.monitorclocking();
664         return 1;
665
666     def monitor_list_apps(self, full=False): 
667         self.monitor_info()
668         old_value = self.besilent
669         self.besilent = True    # turn off automatic call to readcmd
670         self.writecmd(self.MONITORAPP, 0x82, 1, [int(full)]);
671         self.besilent = old_value
672         
673         # read the build date string 
674         self.readcmd()
675         print "Build Date: %s" % self.data
676         print "Firmware apps:"
677         while True:
678             self.readcmd()
679             if self.count == 0:
680                 break
681             print self.data
682         return 1;
683
684     def monitorclocking(self):
685         """Return the 16-bit clocking value."""
686         return "0x%04x" % self.monitorgetclock();
687     
688     def monitorsetclock(self,clock):
689         """Set the clocking value."""
690         self.MONpoke16(0x56, clock);
691     def monitorgetclock(self):
692         """Get the clocking value."""
693         if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
694             return 0xDEAD;
695         #Check for MSP430 before peeking this.
696         return self.MONpeek16(0x56);
697     # The following functions ought to be implemented in
698     # every client.
699     
700     def infostring(self):
701         if(os.environ.get("platform")=='arduino' or os.environ.get("board")=='arduino'):
702             return "Arduino";
703         else:
704             a=self.MONpeek8(0xff0);
705             b=self.MONpeek8(0xff1);
706             return "%02x%02x" % (a,b);
707     def lock(self):
708         print "Locking Unsupported.";
709     def erase(self):
710         print "Erasure Unsupported.";
711     def setup(self):
712         return;
713     def start(self):
714         return;
715     def test(self):
716         print "Unimplemented.";
717         return;
718     def status(self):
719         print "Unimplemented.";
720         return;
721     def halt(self):
722         print "Unimplemented.";
723         return;
724     def resume(self):
725         print "Unimplemented.";
726         return;
727     def getpc(self):
728         print "Unimplemented.";
729         return 0xdead;
730     def flash(self,file):
731         """Flash an intel hex file to code memory."""
732         print "Flash not implemented.";
733     def dump(self,file,start=0,stop=0xffff):
734         """Dump an intel hex file from code memory."""
735         print "Dump not implemented.";
736     def peek32(self,address, memory="vn"):
737         """Peek 32 bits."""
738         return (self.peek16(address,memory)+
739                 (self.peek16(address+2,memory)<<16));
740     def peek16(self,address, memory="vn"):
741         """Peek 16 bits of memory."""
742         return (self.peek8(address,memory)+
743                 (self.peek8(address+1,memory)<<8));
744     def peek8(self,address, memory="vn"):
745         """Peek a byte of memory."""
746         return self.MONpeek8(address); #monitor
747     def peekblock(self,address,length,memory="vn"):
748         """Return a block of data."""
749         data=range(0,length);
750         for foo in range(0,length):
751             data[foo]=self.peek8(address+foo,memory);
752         return data;
753     def pokeblock(self,address,bytes,memory="vn"):
754         """Poke a block of a data into memory at an address."""
755         for foo in bytes:
756             self.pokebyte(address,foo,memory);
757             address=address+1;
758         return;
759     def loadsymbols(self):
760         """Load symbols from a file."""
761         return;