19e273165a24f7029b36184d32887c61f85b7a31
[goodfet] / client / GoodFETCC.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;
9 import binascii;
10
11 from GoodFET import GoodFET;
12 from intelhex import IntelHex;
13
14 import xml.dom.minidom;
15
16 class GoodFETCC(GoodFET):
17     """A GoodFET variant for use with Chipcon 8051 Zigbee SoC."""
18     APP=0x30;
19     smartrfpath="/opt/smartrf7";
20     def SRF_chipdom(self,chip="cc1110", doc="register_definition.xml"):
21         fn="%s/config/xml/%s/%s" % (self.smartrfpath,chip,doc);
22         print "Opening %s" % fn;
23         return xml.dom.minidom.parse(fn)
24     def CMDrs(self,args=[]):
25         """Chip command to grab the radio state."""
26         self.SRF_radiostate();
27     def SRF_bitfieldstr(self,bf):
28         name="unused";
29         start=0;
30         stop=0;
31         access="";
32         reset="0x00";
33         description="";
34         for e in bf.childNodes:
35             if e.localName=="Name" and e.childNodes: name= e.childNodes[0].nodeValue;
36             elif e.localName=="Start": start=e.childNodes[0].nodeValue;
37             elif e.localName=="Stop": stop=e.childNodes[0].nodeValue;
38         return "   [%s:%s] %30s " % (start,stop,name);
39     def SRF_radiostate(self):
40         ident=self.CCident();
41         chip=self.CCversions.get(ident&0xFF00);
42         dom=self.SRF_chipdom(chip,"register_definition.xml");
43         for e in dom.getElementsByTagName("registerdefinition"):
44             for f in e.childNodes:
45                 if f.localName=="DeviceName":
46                     print "// %s RadioState" % (f.childNodes[0].nodeValue);
47                 elif f.localName=="Register":
48                     name="unknownreg";
49                     address="0xdead";
50                     description="";
51                     bitfields="";
52                     for g in f.childNodes:
53                         if g.localName=="Name":
54                             name=g.childNodes[0].nodeValue;
55                         elif g.localName=="Address":
56                             address=g.childNodes[0].nodeValue;
57                         elif g.localName=="Description":
58                             if g.childNodes:
59                                 description=g.childNodes[0].nodeValue;
60                         elif g.localName=="Bitfield":
61                             bitfields+="%17s/* %-50s */\n" % ("",self.SRF_bitfieldstr(g));
62                     #print "SFRX(%10s, %s); /* %50s */" % (name,address, description);
63                     print "%-10s=0x%02x; /* %-50s */" % (
64                         name,self.CCpeekdatabyte(eval(address)), description);
65                     if bitfields!="": print bitfields.rstrip();
66     def halt(self):
67         """Halt the CPU."""
68         self.CChaltcpu();
69     def CChaltcpu(self):
70         """Halt the CPU."""
71         self.writecmd(self.APP,0x86,0,self.data);
72     def resume(self):
73         self.CCreleasecpu();
74     def CCreleasecpu(self):
75         """Resume the CPU."""
76         self.writecmd(self.APP,0x87,0,self.data);
77     def test(self):
78         self.CCreleasecpu();
79         self.CChaltcpu();
80         #print "Status: %s" % self.CCstatusstr();
81         
82         #Grab ident three times, should be equal.
83         ident1=self.CCident();
84         ident2=self.CCident();
85         ident3=self.CCident();
86         if(ident1!=ident2 or ident2!=ident3):
87             print "Error, repeated ident attempts unequal."
88             print "%04x, %04x, %04x" % (ident1, ident2, ident3);
89         
90         #Single step, printing PC.
91         print "Tracing execution at startup."
92         for i in range(1,15):
93             pc=self.CCgetPC();
94             byte=self.CCpeekcodebyte(i);
95             #print "PC=%04x, %02x" % (pc, byte);
96             self.CCstep_instr();
97         
98         print "Verifying that debugging a NOP doesn't affect the PC."
99         for i in range(1,15):
100             pc=self.CCgetPC();
101             self.CCdebuginstr([0x00]);
102             if(pc!=self.CCgetPC()):
103                 print "ERROR: PC changed during CCdebuginstr([NOP])!";
104         
105         print "Checking pokes to XRAM."
106         for i in range(0xf000,0xf020):
107             self.CCpokedatabyte(i,0xde);
108             if(self.CCpeekdatabyte(i)!=0xde):
109                 print "Error in XDATA at 0x%04x" % i;
110         
111         #print "Status: %s." % self.CCstatusstr();
112         #Exit debugger
113         self.stop();
114         print "Done.";
115
116     def setup(self):
117         """Move the FET into the CC2430/CC2530 application."""
118         #print "Initializing Chipcon.";
119         self.writecmd(self.APP,0x10,0,self.data);
120     def CCrd_config(self):
121         """Read the config register of a Chipcon."""
122         self.writecmd(self.APP,0x82,0,self.data);
123         return ord(self.data[0]);
124     def CCwr_config(self,config):
125         """Write the config register of a Chipcon."""
126         self.writecmd(self.APP,0x81,1,[config&0xFF]);
127     def CClockchip(self):
128         """Set the flash lock bit in info mem."""
129         self.writecmd(self.APP, 0x9A, 0, None);
130     def lock(self):
131         """Set the flash lock bit in info mem."""
132         self.CClockchip();
133     
134
135     CCversions={0x0100:"cc1110",
136                 0x8500:"cc2430",
137                 0x8900:"cc2431",
138                 0x8100:"cc2510",
139                 0x9100:"cc2511",
140                 0xA500:"cc2530", #page 52 of SWRU191
141                 0xB500:"cc2531",
142                 0xFF00:"CCmissing"};
143     CCpagesizes={0x01: 1024, #"CC1110",
144                  0x85: 2048, #"CC2430",
145                  0x89: 2048, #"CC2431",
146                  0x81: 1024, #"CC2510",
147                  0x91: 1024, #"CC2511",
148                  0xA5: 2048, #"CC2530", #page 52 of SWRU191
149                  0xB5: 2048, #"CC2531",
150                  0xFF: 0    } #"CCmissing"};
151     def infostring(self):
152         return self.CCidentstr();
153     def CCidentstr(self):
154         ident=self.CCident();
155         chip=self.CCversions.get(ident&0xFF00);
156         return "%s/r%02x" % (chip, ident&0xFF); 
157     def CCident(self):
158         """Get a chipcon's ID."""
159         self.writecmd(self.APP,0x8B,0,None);
160         chip=ord(self.data[0]);
161         rev=ord(self.data[1]);
162         return (chip<<8)+rev;
163     def CCpagesize(self):
164         """Get a chipcon's ID."""
165         self.writecmd(self.APP,0x8B,0,None);
166         chip=ord(self.data[0]);
167         size=self.CCpagesizes.get(chip);
168         if(size<10):
169             print "ERROR: Pagesize undefined.";
170             print "chip=%02x" %chip;
171             sys.exit(1);
172             #return 2048;
173         return size;
174     def CCgetPC(self):
175         """Get a chipcon's PC."""
176         self.writecmd(self.APP,0x83,0,None);
177         hi=ord(self.data[0]);
178         lo=ord(self.data[1]);
179         return (hi<<8)+lo;
180     def CCcmd(self,phrase):
181         self.writecmd(self.APP,0x00,len(phrase),phrase);
182         val=ord(self.data[0]);
183         print "Got %02x" % val;
184         return val;
185     def CCdebuginstr(self,instr):
186         self.writecmd(self.APP,0x88,len(instr),instr);
187         return ord(self.data[0]);
188     def peek8(self,address, memory="code"):
189         if(memory=="code" or memory=="flash" or memory=="vn"):
190             return self.CCpeekcodebyte(address);
191         elif(memory=="data" or memory=="xdata" or memory=="ram"):
192             return self.CCpeekdatabyte(address);
193         elif(memory=="idata" or memory=="iram"):
194             return self.CCpeekirambyte(address);
195         print "%s is an unknown memory." % memory;
196         return 0xdead;
197     def CCpeekcodebyte(self,adr):
198         """Read the contents of code memory at an address."""
199         self.data=[adr&0xff, (adr&0xff00)>>8];
200         self.writecmd(self.APP,0x90,2,self.data);
201         return ord(self.data[0]);
202     def CCpeekdatabyte(self,adr):
203         """Read the contents of data memory at an address."""
204         self.data=[adr&0xff, (adr&0xff00)>>8];
205         self.writecmd(self.APP,0x91, 2, self.data);
206         return ord(self.data[0]);
207     def CCpeekirambyte(self,adr):
208         """Read the contents of IRAM at an address."""
209         self.data=[adr&0xff];
210         self.writecmd(self.APP,0x02, 1, self.data);
211         return ord(self.data[0]);
212     def CCpeekiramword(self,adr):
213         """Read the little-endian contents of IRAM at an address."""
214         return self.CCpeekirambyte(adr)+(
215             self.CCpeekirambyte(adr+1)<<8);
216     def CCpokeiramword(self,adr,val):
217         self.CCpokeirambyte(adr,val&0xff);
218         self.CCpokeirambyte(adr+1,(val>>8)&0xff);
219     def CCpokeirambyte(self,adr,val):
220         """Write the contents of IRAM at an address."""
221         self.data=[adr&0xff, val&0xff];
222         self.writecmd(self.APP,0x02, 2, self.data);
223         return ord(self.data[0]);
224     
225     def CCpokedatabyte(self,adr,val):
226         """Write a byte to data memory."""
227         self.data=[adr&0xff, (adr&0xff00)>>8, val];
228         self.writecmd(self.APP, 0x92, 3, self.data);
229         return ord(self.data[0]);
230     def CCchiperase(self):
231         """Erase all of the target's memory."""
232         self.writecmd(self.APP,0x80,0,None);
233     def erase(self):
234         """Erase all of the target's memory."""
235         self.CCchiperase();
236     
237     def CCstatus(self):
238         """Check the status."""
239         self.writecmd(self.APP,0x84,0,None);
240         return ord(self.data[0])
241     #Same as CC2530
242     CCstatusbits={0x80 : "erase_busy",
243                   0x40 : "pcon_idle",
244                   0x20 : "cpu_halted",
245                   0x10 : "pm0",
246                   0x08 : "halt_status",
247                   0x04 : "locked",
248                   0x02 : "oscstable",
249                   0x01 : "overflow"
250                   };
251     CCconfigbits={0x20 : "soft_power_mode",   #new for CC2530
252                   0x08 : "timers_off",
253                   0x04 : "dma_pause",
254                   0x02 : "timer_suspend",
255                   0x01 : "sel_flash_info_page" #stricken from CC2530
256                   };
257                   
258     def status(self):
259         """Check the status as a string."""
260         status=self.CCstatus();
261         str="";
262         i=1;
263         while i<0x100:
264             if(status&i):
265                 str="%s %s" %(self.CCstatusbits[i],str);
266             i*=2;
267         return str;
268     def start(self):
269         """Start debugging."""
270         self.setup();
271         self.writecmd(self.APP,0x20,0,self.data);
272         ident=self.CCidentstr();
273         #print "Target identifies as %s." % ident;
274         #print "Status: %s." % self.status();
275         self.CCreleasecpu();
276         self.CChaltcpu();
277         #print "Status: %s." % self.status();
278         
279     def stop(self):
280         """Stop debugging."""
281         self.writecmd(self.APP,0x21,0,self.data);
282     def CCstep_instr(self):
283         """Step one instruction."""
284         self.writecmd(self.APP,0x89,0,self.data);
285     def CCeraseflashbuffer(self):
286         """Erase the 2kB flash buffer"""
287         self.writecmd(self.APP,0x99);
288     def CCflashpage(self,adr):
289         """Flash 2kB a page of flash from 0xF000 in XDATA"""
290         data=[adr&0xFF,
291               (adr>>8)&0xFF,
292               (adr>>16)&0xFF,
293               (adr>>24)&0xFF];
294         print "Flashing buffer to 0x%06x" % adr;
295         self.writecmd(self.APP,0x95,4,data);
296
297     def flash(self,file):
298         """Flash an intel hex file to code memory."""
299         print "Flashing %s" % file;
300         
301         h = IntelHex(file);
302         page = 0x0000;
303         pagelen = self.CCpagesize(); #Varies by chip.
304         
305         #print "page=%04x, pagelen=%04x" % (page,pagelen);
306         
307         bcount = 0;
308         
309         #Wipe the RAM buffer for the next flash page.
310         self.CCeraseflashbuffer();
311         for i in h._buf.keys():
312             while(i>=page+pagelen):
313                 if bcount>0:
314                     self.CCflashpage(page);
315                     #client.CCeraseflashbuffer();
316                     bcount=0;
317                     print "Flashed page at %06x" % page
318                 page+=pagelen;
319                     
320             #Place byte into buffer.
321             self.CCpokedatabyte(0xF000+i-page,
322                                 h[i]);
323             bcount+=1;
324             if(i%0x100==0):
325                 print "Buffering %04x toward %06x" % (i,page);
326         #last page
327         self.CCflashpage(page);
328         print "Flashed final page at %06x" % page;
329