263e368aa75ebd44cbdab70bf6c4d0ad05e11fbe
[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 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     def CCident(self):
131         """Get a chipcon's ID."""
132         self.writecmd(0x30,0x8B,0,None);
133         chip=ord(self.data[0]);
134         rev=ord(self.data[1]);
135         return (chip<<8)+rev;
136     def MSP430peek(self,adr):
137         """Read the contents of memory at an address."""
138         self.data=[adr&0xff, (adr&0xff00)>>8];
139         self.writecmd(0x11,0x02,2,self.data);
140         return ord(self.data[0])+(ord(self.data[1])<<8);
141     def MSP430poke(self,adr,val):
142         """Read the contents of memory at an address."""
143         self.data=[adr&0xff, (adr&0xff00)>>8, val&0xff, (val&0xff00)>>8];
144         self.writecmd(0x11,0x03,4,self.data);
145         return;# ord(self.data[0])+(ord(self.data[1])<<8);
146     
147     def MSP430start(self):
148         """Start debugging."""
149         self.writecmd(0x11,0x20,0,self.data);
150         ident=self.MSP430ident();
151         print "Target identifies as %04x." % ident;
152     
153     def CCstart(self):
154         """Start debugging."""
155         self.writecmd(0x30,0x20,0,self.data);
156         ident=self.CCident();
157         print "Target identifies as %04x." % ident;
158     def CCstop(self):
159         """Stop debugging."""
160         self.writecmd(0x30,0x21,0,self.data);
161         
162     def MSP430stop(self):
163         """Stop debugging."""
164         self.writecmd(0x11,0x21,0,self.data);
165     def MSP430haltcpu(self):
166         """Halt the CPU."""
167         self.writecmd(0x11,0xA0,0,self.data);
168     def MSP430releasecpu(self):
169         """Resume the CPU."""
170         self.writecmd(0x11,0xA1,0,self.data);
171
172     def MSP430shiftir8(self,ins):
173         """Shift the 8-bit Instruction Register."""
174         data=[ins];
175         self.writecmd(0x11,0x80,1,data);
176         return ord(self.data[0]);
177     def MSP430shiftdr16(self,dat):
178         """Shift the 16-bit Data Register."""
179         data=[dat&0xFF,(dat&0xFF00)>>8];
180         self.writecmd(0x11,0x81,2,data);
181         return ord(self.data[0])#+(ord(self.data[1])<<8);
182     def MSP430setinstrfetch(self):
183         """Set the instruction fetch mode."""
184         self.writecmd(0x11,0xC1,0,self.data);
185         return self.data[0];
186     def MSP430ident(self):
187         """Grab self-identification word from 0x0FF0 as big endian."""
188         i=self.MSP430peek(0x0ff0);
189         return ((i&0xFF00)>>8)+((i&0xFF)<<8)
190     def MSP430test(self):
191         """Test MSP430 JTAG.  Requires that a chip be attached."""
192         if self.MSP430ident()==0xffff:
193             print "Is anything connected?";
194         print "Testing RAM.";
195         temp=self.MSP430peek(0x0200);
196         self.MSP430poke(0x0200,0xdead);
197         if(self.MSP430peek(0x0200)!=0xdead):
198             print "Poke of 0x0200 did not set to 0xDEAD properly.";
199             return;
200         self.MSP430poke(0x0200,temp); #restore old value.
201     def MSP430flashtest(self):
202         self.MSP430masserase();
203         i=0x2500;
204         while(i<0xFFFF):
205             if(self.MSP430peek(i)!=0xFFFF):
206                 print "ERROR: Unerased flash at %04x."%i;
207             self.MSP430writeflash(i,0xDEAD);
208             i+=2;
209     def MSP430masserase(self):
210         """Erase MSP430 flash memory."""
211         self.writecmd(0x11,0xE3,0,None);
212     def MSP430writeflash(self,adr,val):
213         """Write a word of flash memory."""
214         if(self.MSP430peek(adr)!=0xFFFF):
215             print "FLASH ERROR: %04x not clear." % adr;
216         data=[adr&0xFF,(adr&0xFF00)>>8,val&0xFF,(val&0xFF00)>>8];
217         self.writecmd(0x11,0xE1,4,data);
218         rval=ord(self.data[0])+(ord(self.data[1])<<8);
219         if(val!=rval):
220             print "FLASH WRITE ERROR AT %04x.  Found %04x, wrote %04x." % (adr,rval,val);
221             
222     def MSP430dumpbsl(self):
223         self.MSP430dumpmem(0xC00,0xfff);
224     def MSP430dumpallmem(self):
225         self.MSP430dumpmem(0x200,0xffff);
226     def MSP430dumpmem(self,begin,end):
227         i=begin;
228         while i<end:
229             print "%04x %04x" % (i, self.MSP430peek(i));
230             i+=2;
231
232     def CCtest(self):
233         self.CCstop();
234         print "Done.";